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:
79
docs/_templates/README.md
vendored
Normal file
79
docs/_templates/README.md
vendored
Normal file
@@ -0,0 +1,79 @@
|
||||
# 文档模板
|
||||
|
||||
> **目录说明:** 本目录包含各类文档的标准模板
|
||||
> **使用方法:** 创建新文档时,复制对应模板,填充内容
|
||||
|
||||
---
|
||||
|
||||
## 📋 模板清单
|
||||
|
||||
| 模板 | 说明 | 适用场景 |
|
||||
|------|------|---------|
|
||||
| **[AI对接] 快速上下文-模板.md** | 快速上下文文档模板 | 创建新模块/能力时 |
|
||||
| **模块README-模板.md** | 模块README模板 | 创建新业务模块时 |
|
||||
|
||||
---
|
||||
|
||||
## 🎯 使用说明
|
||||
|
||||
### 1. 创建新业务模块
|
||||
|
||||
**步骤:**
|
||||
1. 复制 `模块README-模板.md` 到新模块目录
|
||||
2. 重命名为 `README.md`
|
||||
3. 填充所有 `[占位符]` 内容
|
||||
4. 删除不需要的章节
|
||||
|
||||
### 2. 创建快速上下文文档
|
||||
|
||||
**步骤:**
|
||||
1. 复制 `[AI对接] 快速上下文-模板.md` 到对应目录
|
||||
2. 重命名为 `[AI对接] [模块代号]快速上下文.md`
|
||||
3. 填充所有内容
|
||||
4. 确保Token消耗在目标范围内
|
||||
|
||||
---
|
||||
|
||||
## 📏 模板规范
|
||||
|
||||
### 快速上下文文档规范
|
||||
|
||||
**L0级别(总体):**
|
||||
- Token消耗:~800
|
||||
- 阅读时间:2分钟
|
||||
- 内容:项目全貌、快速跳转
|
||||
|
||||
**L1级别(层级):**
|
||||
- Token消耗:~1500
|
||||
- 阅读时间:3分钟
|
||||
- 内容:层级概览、模块清单
|
||||
|
||||
**L2级别(模块):**
|
||||
- Token消耗:~2000
|
||||
- 阅读时间:5分钟
|
||||
- 内容:模块详情、开发指南
|
||||
|
||||
---
|
||||
|
||||
## 🔗 相关文档
|
||||
|
||||
- [文档体系重构方案](../00-系统总体设计/02-文档体系重构方案.md)
|
||||
|
||||
---
|
||||
|
||||
**最后更新:** 2025-11-06
|
||||
**维护人:** 技术架构师
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user