104 lines
2.9 KiB
Markdown
104 lines
2.9 KiB
Markdown
|
---
|
|||
|
|
name: "update-docs"
|
|||
|
|
description: "Updates project documentation (README.md, changelog, PROJECT_CONTEXT.md, etc.). Invoke after any code/structure change to keep docs in sync."
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
# 更新文档 Skill
|
|||
|
|
|
|||
|
|
## 功能
|
|||
|
|
|
|||
|
|
在任何代码、结构、配置变更后，自动更新所有相关的项目文档，确保文档与实际状态一致。
|
|||
|
|
|
|||
|
|
## 触发条件
|
|||
|
|
|
|||
|
|
- 目录结构变更（新增/删除/重命名目录）
|
|||
|
|
- 角色/权限变更（宪法更新后）
|
|||
|
|
- 工作流变更
|
|||
|
|
- Skill 文件变更
|
|||
|
|
- 任何可能影响文档的变更
|
|||
|
|
|
|||
|
|
## 执行步骤
|
|||
|
|
|
|||
|
|
### 1. 识别变更影响范围
|
|||
|
|
|
|||
|
|
| 变更类型 | 需更新的文档 |
|
|||
|
|
|---------|-------------|
|
|||
|
|
| 目录结构变更 | README.md 目录树、PROJECT_CONTEXT.md 结构图 |
|
|||
|
|
| 角色/权限变更 | README.md 团队角色表、PROJECT_CONTEXT.md |
|
|||
|
|
| 工作流变更 | README.md 工作流程、PROJECT_CONTEXT.md |
|
|||
|
|
| Skill 文件变更 | README.md（如提及 Skill） |
|
|||
|
|
| 任何提交 | 变更日志 |
|
|||
|
|
|
|||
|
|
### 2. 更新文档
|
|||
|
|
|
|||
|
|
按以下顺序更新：
|
|||
|
|
|
|||
|
|
#### 2.1 README.md
|
|||
|
|
|
|||
|
|
- [ ] 更新项目描述（如适用）
|
|||
|
|
- [ ] 更新目录结构树
|
|||
|
|
- [ ] 更新团队角色表
|
|||
|
|
- [ ] 更新工作流程说明
|
|||
|
|
- [ ] 更新任务状态流转（如适用）
|
|||
|
|
|
|||
|
|
#### 2.2 docs/PROJECT_CONTEXT.md
|
|||
|
|
|
|||
|
|
- [ ] 更新当前阶段
|
|||
|
|
- [ ] 更新项目结构图
|
|||
|
|
- [ ] 更新关键决策（如适用）
|
|||
|
|
- [ ] 更新待解决问题（如适用）
|
|||
|
|
- [ ] 更新下一步计划
|
|||
|
|
|
|||
|
|
#### 2.3 docs/05_变更日志/YYYY-MM-DD.md
|
|||
|
|
|
|||
|
|
- [ ] 创建今日日志文件（如不存在）
|
|||
|
|
- [ ] 添加本次提交记录
|
|||
|
|
- [ ] 包含 commit hash、简要描述、具体变更
|
|||
|
|
|
|||
|
|
#### 2.4 docs/DECISIONS.md（如适用）
|
|||
|
|
|
|||
|
|
- [ ] 新增架构决策记录（ADR）
|
|||
|
|
- [ ] 格式：背景、决策、原因、后果
|
|||
|
|
|
|||
|
|
#### 2.5 docs/06_开发日志/YYYY-MM-DD_主题.md（如适用）
|
|||
|
|
|
|||
|
|
- [ ] 记录讨论内容
|
|||
|
|
- [ ] 记录关键决策
|
|||
|
|
- [ ] 记录完成的工作
|
|||
|
|
- [ ] 记录待办事项
|
|||
|
|
|
|||
|
|
### 3. 验证一致性
|
|||
|
|
|
|||
|
|
- [ ] README.md 目录树 与实际目录结构一致
|
|||
|
|
- [ ] README.md 团队角色表 与 AGENTS.md 一致
|
|||
|
|
- [ ] README.md 工作流程 与 workflow.json 一致
|
|||
|
|
- [ ] PROJECT_CONTEXT.md 结构图 与实际一致
|
|||
|
|
- [ ] 变更日志包含所有今日提交
|
|||
|
|
|
|||
|
|
### 4. 提交 Git
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
git add -A
|
|||
|
|
git commit -m "docs(readme): 同步文档 - [简要描述]
|
|||
|
|
|
|||
|
|
- README.md: [具体变更]
|
|||
|
|
- PROJECT_CONTEXT.md: [具体变更]
|
|||
|
|
- docs/05_变更日志/YYYY-MM-DD.md: [具体变更]"
|
|||
|
|
git push
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 注意事项
|
|||
|
|
|
|||
|
|
1. **变更日志是必须的**：每次提交都必须更新变更日志，不能忘
|
|||
|
|
2. **README.md 是门面**：项目的第一印象，必须保持最新
|
|||
|
|
3. **PROJECT_CONTEXT.md 是上下文**：换电脑后 AI 读取的核心文档
|
|||
|
|
4. **不要过度更新**：只更新受影响的文档，不要全量重写
|
|||
|
|
5. **保持简洁**：文档更新提交信息要简洁明了
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
**Version**: 1.0
|
|||
|
|
**Created**: 2026-05-23
|
|||
|
|
**Based On**: ErrLens AI Programming Project
|
|||
|
|
**Purpose**: 确保文档与代码/结构同步更新，避免"繁文缛节"被遗忘
|