Skip to content

Docs: finalize design + experiment report with real benchmark data and plots

王俊泽 requested to merge docs/readme-update into main

概述

本 MR 完成了文档、实验与过程性资料，补齐项目的可读性与可验证性证据链。

变更内容

1) 设计文档

  • 新增 DESIGN.md：系统架构、模块划分、关键流程与设计取舍说明
  • 补充架构图源文件：docs/diagrams/mikudb-architecture.puml

2) 实验报告与性能评测

  • 新增 EXPERIMENT.md：实验环境、方法、步骤、指标与结论
  • 提供真实运行产生的原始数据：bench_data/read_latency.csv
  • 提供论文风性能图（由脚本生成）：
    • _images/perf/index_latency_comparison.png
    • _images/perf/fulltext_latency.png
  • 提供可复现实验绘图脚本：plot_perf_local.py

3) README 完善

  • 更新 README.md：补充图文说明、引用设计文档与实验结果，并完善展示内容（架构、运行状态、CLI 示例等）
  • 新增/整理图片资源目录：_images/（arch/perf/ui 等）

可验证性说明（重要）

  • 性能数据来源：真实服务器环境运行所得（CSV 保留在仓库）
  • 图表生成：使用 Python + matplotlib 脚本生成（脚本已随仓库提交，可复现）
  • 演示/示例命令：均以实际可运行输出为依据整理到文档中

文件清单

  • README.md
  • DESIGN.md
  • EXPERIMENT.md
  • bench_data/read_latency.csv
  • plot_perf_local.py
  • docs/diagrams/mikudb-architecture.puml
  • _images/arch/* _images/perf/* _images/ui/*

备注

本 MR 仅新增与完善文档与实验材料，不改动核心功能代码逻辑。

Merge request reports