CodePilot — 技术文档导航¶
AI 编程助手 · 语料库 + 模型 + 插件
📚 文档索引¶
项目概览¶
| 文档 | 说明 |
|---|---|
| 项目启动报告 | 项目立项与目标 |
| 01-周进度报告 | 每周进度汇总 |
| 02-会议纪要 | 会议记录 |
| 03-问题追踪 | Bug 与问题跟踪 |
| 04-项目执行方案 | 执行计划 |
技术文档¶
| 文档 | 说明 |
|---|---|
| 01-市场调研 | 市场分析 |
| 02-竞品分析 | 竞品对比 |
| 03-技术方案 | 技术架构 |
| architecture/overview.md | 系统架构总览 |
| api/ | API 接口文档 |
| models/ | 模型训练与推理 |
决策记录¶
- decisions/adr/ — 架构决策记录(ADR)
运维¶
- ops/deployment/ — 部署文档
- ops/monitoring/ — 监控文档
参考¶
- references/specs/ — 规格说明
- references/templates/ — 文档模板
- exports/ — 导出文件
🖼️ 图表说明¶
架构图使用 Mermaid 语法编写: - Mermaid 源文件:architecture/diagrams/*.mmd - 导出图片:architecture/images/*.png
📋 文档规范¶
- Markdown 格式,UTF-8 编码
- 架构图使用 Mermaid(
.mmd) - 截图存放在
images/子目录 - ADR 按编号命名:
001-xxx.md - 文档与代码同仓库
最后更新:2026-05-01