document_rules.md•3.43 kB
# Memory Bank 文档规则
## 文档管理原则
1. **一致性** - 所有项目文档应当遵循统一的格式和结构
2. **完整性** - 文档应包含所有必要信息，避免重要内容缺失
3. **实时性** - 及时更新文档以反映当前项目状态
4. **可追溯性** - 保持文档的版本历史和变更记录
5. **可读性** - 文档结构清晰，内容易于阅读和理解
## 项目必备文档
每个项目必须包含以下核心文档:
### 1. projectbrief.md (项目概述)
**结构要求:**
```markdown
# 项目名称
## 项目目标
[描述本项目的总体目标和预期成果]
## 需求列表
- [需求1]
- [需求2]
...
## 技术栈
- [技术1]
- [技术2]
...
## 时间线
- [日期1]: [里程碑1]
- [日期2]: [里程碑2]
...
## 项目团队
- [角色1]: [人员1]
- [角色2]: [人员2]
...
```
### 2. tasks.md (任务列表)
**结构要求:**
```markdown
# 任务列表
## 待办任务
- [ ] [优先级] [任务1]
- [ ] [优先级] [任务2]
...
## 进行中任务
- [-] [任务3] (@责任人)
- [-] [任务4] (截止日期: YYYY-MM-DD)
...
## 已完成任务
- [x] [任务5] (完成日期: YYYY-MM-DD)
- [x] [任务6]
...
```
### 3. activeContext.md (当前上下文)
**结构要求:**
```markdown
# 当前工作上下文
## 最近更新
[日期]: [更新内容概述]
## 当前状态
[描述项目当前的整体状态]
## 工作重点
- [重点1]
- [重点2]
...
## 决策记录
- [决策1]: [原因和影响]
- [决策2]: [原因和影响]
...
## 问题和障碍
- [问题1]: [状态]
- [问题2]: [状态]
...
## 下一步计划
- [计划1]
- [计划2]
...
```
## 文档格式规范
### Markdown基本格式
1. **标题格式**
- 文档标题: # (H1)
- 主要章节: ## (H2)
- 次要章节: ### (H3)
- 子节: #### (H4)
2. **列表格式**
- 无序列表使用 `-` 或 `*`
- 有序列表使用 `1.`, `2.`, ...
- 任务列表使用 `- [ ]`, `- [x]`
3. **强调格式**
- 重要内容使用 **粗体**
- 次要强调使用 *斜体*
- 代码使用 `反引号`
4. **链接和引用**
- 文档间链接: `[文档名称](相对路径)`
- 章节链接: `[章节名称](#章节-锚点)`
- 引用格式: `> 引用内容`
### 特定内容规范
1. **日期格式**
- 使用ISO格式: `YYYY-MM-DD`
- 完整时间戳格式: `YYYY-MM-DD HH:MM:SS`
2. **状态标记**
- 未开始: `[未开始]`
- 进行中: `[进行中]`
- 已完成: `[已完成]`
- 阻塞: `[阻塞]`
- 延期: `[延期]`
3. **优先级标记**
- 高优先级: `[高]`
- 中优先级: `[中]`
- 低优先级: `[低]`
4. **变更记录**
- 添加: `[+] 新增内容`
- 修改: `[~] 修改内容`
- 删除: `[-] 删除内容`
## 文档更新频率
不同类型的文档有不同的建议更新频率:
1. **activeContext.md**: 实时更新，至少每次工作会话结束前更新
2. **tasks.md**: 任务状态变更时实时更新
3. **progress.md**: 每周至少更新一次
4. **projectbrief.md**: 项目范围或目标变更时更新
5. **systemPatterns.md**: 架构决策变更时更新
6. **techContext.md**: 技术栈或开发环境变更时更新
## 文档审核机制
定期审核文档以确保质量:
1. 每周进行一次文档完整性检查
2. 确保所有必要信息都已记录
3. 验证文档的一致性和准确性
4. 清理过时信息并更新文档状态
当前文档规则版本: 1.0.0