feat(skill): 新增 update-constitution 和 update-docs 两个 Skill
- update-constitution: 更新宪法文件（AGENTS.md、配置文件、权限矩阵） - 确保角色/权限/工作流变更时所有文件同步更新 - 包含一致性验证步骤 - update-docs: 更新项目文档（README.md、变更日志、PROJECT_CONTEXT.md） - 确保目录结构/角色/工作流变更后文档同步更新 - 强制要求更新变更日志，避免遗忘 解决痛点：核心代码改了，文档和变更日志容易忘
This commit is contained in:
@@ -0,0 +1,95 @@
|
|||||||
|
---
|
||||||
|
name: "update-constitution"
|
||||||
|
description: "Updates AI constitution files (AGENTS.md, config files, permission matrix). Invoke when AI roles, permissions, or workflow rules change."
|
||||||
|
---
|
||||||
|
|
||||||
|
# 更新宪法 Skill
|
||||||
|
|
||||||
|
## 功能
|
||||||
|
|
||||||
|
当 AI 角色、权限、工作流规则发生变更时，自动更新所有相关的宪法文件，确保一致性。
|
||||||
|
|
||||||
|
## 触发条件
|
||||||
|
|
||||||
|
- AI 角色增加/删除/修改
|
||||||
|
- 权限矩阵变更（allowed_paths、read_only_paths、forbidden_paths）
|
||||||
|
- 工作流阶段变更
|
||||||
|
- 沟通规范变更
|
||||||
|
- 命名规范变更
|
||||||
|
|
||||||
|
## 执行步骤
|
||||||
|
|
||||||
|
### 1. 识别变更类型
|
||||||
|
|
||||||
|
| 变更类型 | 影响文件 |
|
||||||
|
|---------|---------|
|
||||||
|
| 新增 AI 角色 | AGENTS.md、.ai/config/<role>.json、workflow.json、权限矩阵 |
|
||||||
|
| 权限变更 | AGENTS.md 权限矩阵、.ai/config/*.json |
|
||||||
|
| 工作流变更 | AGENTS.md 工作流程图、workflow.json |
|
||||||
|
| 沟通规范变更 | AGENTS.md 沟通规范章节 |
|
||||||
|
| 命名规范变更 | AGENTS.md 命名规范章节 |
|
||||||
|
|
||||||
|
### 2. 更新宪法文件
|
||||||
|
|
||||||
|
按以下顺序更新：
|
||||||
|
|
||||||
|
#### 2.1 AGENTS.md
|
||||||
|
|
||||||
|
- [ ] 更新团队架构图
|
||||||
|
- [ ] 更新角色职责（新增/修改/删除）
|
||||||
|
- [ ] 更新目录权限矩阵
|
||||||
|
- [ ] 更新工作流程图（如适用）
|
||||||
|
- [ ] 更新详细流程说明（如适用）
|
||||||
|
- [ ] 更新 AI 配置文件说明表
|
||||||
|
|
||||||
|
#### 2.2 .ai/config/*.json
|
||||||
|
|
||||||
|
- [ ] 新增/更新对应角色的 JSON 配置文件
|
||||||
|
- [ ] 确保 allowed_paths、read_only_paths、forbidden_paths 与权限矩阵一致
|
||||||
|
- [ ] 确保 responsibilities 与角色职责一致
|
||||||
|
- [ ] 确保 prompt_templates 指向正确的提示词目录
|
||||||
|
|
||||||
|
#### 2.3 .ai/config/workflow.json
|
||||||
|
|
||||||
|
- [ ] 更新 roles 数组
|
||||||
|
- [ ] 更新 stages 数组（新增/修改/删除阶段）
|
||||||
|
- [ ] 确保 actor 字段与角色 ID 一致
|
||||||
|
|
||||||
|
### 3. 更新 Skill 文件
|
||||||
|
|
||||||
|
- [ ] .trae/skills/ai-collab-setup/SKILL.md - 目录结构、权限矩阵、角色描述、配置文件示例
|
||||||
|
- [ ] .trae/skills/resume-context/SKILL.md - 角色识别逻辑、配置文件读取
|
||||||
|
|
||||||
|
### 4. 验证一致性
|
||||||
|
|
||||||
|
- [ ] AGENTS.md 权限矩阵 与 .ai/config/*.json 路径配置一致
|
||||||
|
- [ ] AGENTS.md 角色职责 与 .ai/config/*.json responsibilities 一致
|
||||||
|
- [ ] AGENTS.md 工作流程图 与 workflow.json stages 一致
|
||||||
|
- [ ] 所有 JSON 文件语法正确（使用 python -m json.tool 验证）
|
||||||
|
|
||||||
|
### 5. 提交 Git
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git add -A
|
||||||
|
git commit -m "feat(constitution): 更新宪法 - [简要描述变更内容]
|
||||||
|
|
||||||
|
- AGENTS.md: [具体变更]
|
||||||
|
- .ai/config/*.json: [具体变更]
|
||||||
|
- workflow.json: [具体变更]
|
||||||
|
- ai-collab-setup/SKILL.md: [具体变更]"
|
||||||
|
git push
|
||||||
|
```
|
||||||
|
|
||||||
|
## 注意事项
|
||||||
|
|
||||||
|
1. **权限矩阵是核心**：所有路径变更必须先更新权限矩阵，再同步到 JSON 配置
|
||||||
|
2. **JSON 语法验证**：每次修改后必须验证 JSON 语法
|
||||||
|
3. **Skill 文件同步**：宪法变更后必须同步更新 ai-collab-setup 和 resume-context Skill
|
||||||
|
4. **版本号**：重大变更需升级 Skill 版本号
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Version**: 1.0
|
||||||
|
**Created**: 2026-05-23
|
||||||
|
**Based On**: ErrLens AI Programming Project
|
||||||
|
**Purpose**: 确保宪法变更时所有相关文件同步更新，避免遗漏
|
||||||
@@ -0,0 +1,103 @@
|
|||||||
|
---
|
||||||
|
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**: 确保文档与代码/结构同步更新，避免"繁文缛节"被遗忘
|
||||||
Reference in New Issue
Block a user