docs: complete documentation system (250+ files)
- System architecture and design documentation - Business module docs (ASL/AIA/PKB/RVW/DC/SSA/ST) - ASL module complete design (quality assurance, tech selection) - Platform layer and common capabilities docs - Development standards and API specifications - Deployment and operations guides - Project management and milestone tracking - Architecture implementation reports - Documentation templates and guides
This commit is contained in:
87
docs/_templates/模块README-模板.md
vendored
Normal file
87
docs/_templates/模块README-模板.md
vendored
Normal file
@@ -0,0 +1,87 @@
|
||||
# [模块代号] - [模块名称]
|
||||
|
||||
> **模块代号:** [代号] ([英文全称])
|
||||
> **开发状态:** [✅已完成 / ⏳开发中 / ⏳规划中]
|
||||
> **商业价值:** ⭐⭐⭐⭐⭐ [评级]
|
||||
> **独立性:** ⭐⭐⭐⭐⭐ [评级]
|
||||
> **优先级:** [P0/P1/P2]
|
||||
|
||||
---
|
||||
|
||||
## 📋 模块概述
|
||||
|
||||
[2-3句话描述模块核心功能和价值]
|
||||
|
||||
**核心价值:** [核心差异化点]
|
||||
|
||||
---
|
||||
|
||||
## 🎯 核心功能
|
||||
|
||||
### [已完成功能 / 计划功能]
|
||||
1. [✅/⏳] **功能1** - 简要描述
|
||||
2. [✅/⏳] **功能2** - 简要描述
|
||||
3. [✅/⏳] **功能3** - 简要描述
|
||||
|
||||
**[本周/下一步]重点:** [当前重点]
|
||||
|
||||
---
|
||||
|
||||
## 📂 文档结构
|
||||
|
||||
```
|
||||
[模块代号]-[模块名称]/
|
||||
├── [AI对接] [代号]快速上下文.md # [状态]
|
||||
├── 00-项目概述/
|
||||
│ ├── 01-产品需求文档(PRD).md # [状态]
|
||||
│ └── README.md
|
||||
├── 01-设计文档/
|
||||
│ ├── 01-技术架构设计.md # [状态]
|
||||
│ ├── 02-数据库设计.md # [状态]
|
||||
│ ├── 03-API设计.md # [状态]
|
||||
│ └── README.md
|
||||
├── 02-业务规则/
|
||||
├── 03-开发计划/
|
||||
├── 04-测试文档/
|
||||
└── README.md # ✅ 当前文档
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 依赖的通用能力
|
||||
|
||||
- **[能力1]** - [用途]
|
||||
- **[能力2]** - [用途]
|
||||
|
||||
---
|
||||
|
||||
## 🎯 商业模式
|
||||
|
||||
**目标客户:** [目标客户群]
|
||||
**售卖方式:** [独立产品 / 组合售卖 / 平台功能]
|
||||
**定价策略:** [定价方式]
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ [技术难点 / 核心特色]
|
||||
|
||||
[如果有特别的技术难点或核心特色,在这里说明]
|
||||
|
||||
---
|
||||
|
||||
**最后更新:** [日期]
|
||||
**维护人:** 技术架构师
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user