docs: 重构文档目录结构并重新组织文档内容
- 将文档重新组织到分类目录中(guides/, reports/, openAPI/等) - 更新文档索引,添加README.md作为文档导航 - 移动并重命名现有文档文件,保持内容不变但结构更清晰 - 更新Claude配置以支持tree命令
Showing
12 changed files
with
106 additions
and
1 deletions
docs/README.md
0 → 100644
| 1 | +# 📚 文档目录导航 | ||
| 2 | + | ||
| 3 | +本目录包含项目的所有文档,按功能分类组织。 | ||
| 4 | + | ||
| 5 | +## 📁 目录结构 | ||
| 6 | + | ||
| 7 | +``` | ||
| 8 | +docs/ | ||
| 9 | +├── CHANGELOG.md # 项目更新日志(保持不变) | ||
| 10 | +├── README.md # 本文件 | ||
| 11 | +│ | ||
| 12 | +├── guides/ # 📘 使用指南和教程 | ||
| 13 | +│ ├── START_HERE.md # 从这里开始 | ||
| 14 | +│ ├── OPENAPI_TO_API_GUIDE.md # OpenAPI 转 API 详细指南 | ||
| 15 | +│ ├── GET_VS_POST_GUIDE.md # GET vs POST 请求处理指南 | ||
| 16 | +│ ├── JSDOC_GENERATION_GUIDE.md # JSDoc 注释生成指南 | ||
| 17 | +│ └── API_USAGE_EXAMPLES.md # API 使用示例 | ||
| 18 | +│ | ||
| 19 | +├── reports/ # 📊 实现报告和文档 | ||
| 20 | +│ ├── IMPLEMENTATION_SUMMARY.md # 技术实现总结 | ||
| 21 | +│ ├── COMPLETION_REPORT.md # 功能完成报告 | ||
| 22 | +│ ├── FINAL_FIX_REPORT.md # 修复完成报告 | ||
| 23 | +│ ├── GET_POST_FIX.md # 修复说明文档 | ||
| 24 | +│ └── UPDATE_LOG.md # 功能更新日志 | ||
| 25 | +│ | ||
| 26 | +├── openAPI/ # 📝 OpenAPI 文档源文件 | ||
| 27 | +│ ├── user/ # 用户模块 | ||
| 28 | +│ └── order/ # 订单模块 | ||
| 29 | +│ | ||
| 30 | +├── Design/ # 🎨 设计文档 | ||
| 31 | +├── PLAN/ # 📋 项目计划 | ||
| 32 | +├── PreDocs/ # 📄 预留文档 | ||
| 33 | +└── TODO/ # ✅ 待办事项 | ||
| 34 | +``` | ||
| 35 | + | ||
| 36 | +## 🚀 快速导航 | ||
| 37 | + | ||
| 38 | +### 新手入门 | ||
| 39 | +👉 **[guides/START_HERE.md](guides/START_HERE.md)** - 快速了解项目功能 | ||
| 40 | + | ||
| 41 | +### 使用指南 | ||
| 42 | +- 📘 [OpenAPI 转 API 详细指南](guides/OPENAPI_TO_API_GUIDE.md) - 完整功能说明 | ||
| 43 | +- 📘 [GET vs POST 请求处理指南](guides/GET_VS_POST_GUIDE.md) - 参数处理详解 | ||
| 44 | +- 📘 [JSDoc 注释生成指南](guides/JSDOC_GENERATION_GUIDE.md) - 注释生成规则 | ||
| 45 | +- 📘 [API 使用示例](guides/API_USAGE_EXAMPLES.md) - 实际使用案例 | ||
| 46 | + | ||
| 47 | +### 技术文档 | ||
| 48 | +- 📊 [技术实现总结](reports/IMPLEMENTATION_SUMMARY.md) - 实现细节 | ||
| 49 | +- 📊 [功能完成报告](reports/COMPLETION_REPORT.md) - 完成情况 | ||
| 50 | +- 📊 [修复完成报告](reports/FINAL_FIX_REPORT.md) - 问题修复 | ||
| 51 | +- 📊 [功能更新日志](reports/UPDATE_LOG.md) - 版本更新 | ||
| 52 | + | ||
| 53 | +## 📖 文档分类说明 | ||
| 54 | + | ||
| 55 | +### 📘 guides/ - 使用指南 | ||
| 56 | +包含面向用户的使用教程和指南文档: | ||
| 57 | +- 快速开始指南 | ||
| 58 | +- 功能详细说明 | ||
| 59 | +- 参数处理规则 | ||
| 60 | +- 代码使用示例 | ||
| 61 | + | ||
| 62 | +### 📊 reports/ - 技术报告 | ||
| 63 | +包含面向开发者的技术实现文档: | ||
| 64 | +- 实现总结 | ||
| 65 | +- 完成报告 | ||
| 66 | +- 修复说明 | ||
| 67 | +- 更新日志 | ||
| 68 | + | ||
| 69 | +### 📝 openAPI/ - API 文档源文件 | ||
| 70 | +OpenAPI 规范的 Markdown 文档,用于生成 API 代码: | ||
| 71 | +- user/ - 用户模块接口 | ||
| 72 | +- order/ - 订单模块接口 | ||
| 73 | + | ||
| 74 | +## 🎯 使用建议 | ||
| 75 | + | ||
| 76 | +### 如果你是新手 | ||
| 77 | +1. 先看 [guides/START_HERE.md](guides/START_HERE.md) | ||
| 78 | +2. 阅读 [guides/OPENAPI_TO_API_GUIDE.md](guides/OPENAPI_TO_API_GUIDE.md) | ||
| 79 | +3. 参考 [guides/API_USAGE_EXAMPLES.md](guides/API_USAGE_EXAMPLES.md) | ||
| 80 | + | ||
| 81 | +### 如果你想了解实现 | ||
| 82 | +1. 查看 [reports/IMPLEMENTATION_SUMMARY.md](reports/IMPLEMENTATION_SUMMARY.md) | ||
| 83 | +2. 阅读 [reports/FINAL_FIX_REPORT.md](reports/FINAL_FIX_REPORT.md) | ||
| 84 | + | ||
| 85 | +### 如果你想生成 API | ||
| 86 | +1. 在 `openAPI/` 目录下创建文档 | ||
| 87 | +2. 运行 `pnpm api:generate` | ||
| 88 | +3. 查看生成的文件 | ||
| 89 | + | ||
| 90 | +## 📝 维护说明 | ||
| 91 | + | ||
| 92 | +### 添加新指南 | ||
| 93 | +放到 `guides/` 目录,并在本 README 中添加说明。 | ||
| 94 | + | ||
| 95 | +### 添加新报告 | ||
| 96 | +放到 `reports/` 目录,并在本 README 中添加说明。 | ||
| 97 | + | ||
| 98 | +### 更新日志 | ||
| 99 | +- 项目级别的更新:修改根目录的 `CHANGELOG.md` | ||
| 100 | +- 功能级别的更新:修改 `reports/UPDATE_LOG.md` | ||
| 101 | + | ||
| 102 | +--- | ||
| 103 | + | ||
| 104 | +**最后更新**: 2026-01-27 |
-
Please register or login to post a comment