📚 文档目录导航

本目录包含项目的所有文档，按功能分类组织。

📁 目录结构

docs/
├── CHANGELOG.md           # 项目更新日志（保持不变）
├── README.md              # 本文件
│
├── guides/                # 📘 使用指南和教程
│   ├── START_HERE.md              # 从这里开始
│   ├── OPENAPI_TO_API_GUIDE.md    # OpenAPI 转 API 详细指南
│   ├── GET_VS_POST_GUIDE.md       # GET vs POST 请求处理指南
│   ├── JSDOC_GENERATION_GUIDE.md  # JSDoc 注释生成指南
│   └── API_USAGE_EXAMPLES.md      # API 使用示例
│
├── reports/               # 📊 实现报告和文档
│   ├── IMPLEMENTATION_SUMMARY.md  # 技术实现总结
│   ├── COMPLETION_REPORT.md       # 功能完成报告
│   ├── FINAL_FIX_REPORT.md        # 修复完成报告
│   ├── GET_POST_FIX.md            # 修复说明文档
│   └── UPDATE_LOG.md              # 功能更新日志
│
├── api-specs/             # 📝 API 规范文档源文件
│   ├── user/                      # 用户模块
│   └── order/                     # 订单模块
│
├── Design/                # 🎨 设计文档
├── PLAN/                  # 📋 项目计划
├── PreDocs/               # 📄 预留文档
└── TODO/                  # ✅ 待办事项

🚀 快速导航

新手入门

👉 guides/START_HERE.md - 快速了解项目功能

使用指南

• 📘 OpenAPI 转 API 详细指南 - 完整功能说明
• 📘 GET vs POST 请求处理指南 - 参数处理详解
• 📘 JSDoc 注释生成指南 - 注释生成规则
• 📘 API 使用示例 - 实际使用案例

技术文档

• 📊 技术实现总结 - 实现细节
• 📊 功能完成报告 - 完成情况
• 📊 修复完成报告 - 问题修复
• 📊 功能更新日志 - 版本更新

📖 文档分类说明

📘 guides/ - 使用指南

包含面向用户的使用教程和指南文档：

• 快速开始指南
• 功能详细说明
• 参数处理规则
• 代码使用示例

📊 reports/ - 技术报告

包含面向开发者的技术实现文档：

• 实现总结
• 完成报告
• 修复说明
• 更新日志

📝 api-specs/ - API 规范文档源文件

OpenAPI 规范的 Markdown 文档，用于生成 API 代码：

• user/ - 用户模块接口
• order/ - 订单模块接口

🎯 使用建议

如果你是新手

1. 先看 guides/START_HERE.md
2. 阅读 guides/OPENAPI_TO_API_GUIDE.md
3. 参考 guides/API_USAGE_EXAMPLES.md

如果你想了解实现

1. 查看 reports/IMPLEMENTATION_SUMMARY.md
2. 阅读 reports/FINAL_FIX_REPORT.md

如果你想生成 API

1. 在 api-specs/ 目录下创建文档
2. 运行 pnpm api:generate
3. 查看生成的文件

📝 维护说明

添加新指南

放到 guides/ 目录，并在本 README 中添加说明。

添加新报告

放到 reports/ 目录，并在本 README 中添加说明。

更新日志

• 项目级别的更新：修改根目录的 CHANGELOG.md
• 功能级别的更新：修改 reports/UPDATE_LOG.md

---

最后更新: 2026-01-27