code-documents-autolisted
Install: claude install-skill trainMini/code-documents-auto-skill
# 代码文档自动管理技能
面向 AI 的代码文档管理系统。
## 核心原则
1. **AI 优先文档**:所有文档都为 AI 消费和项目接管而结构化
2. **强制读取**:任何开发前,必须读取相关文档
3. **完整审计**:所有变更都记录完整上下文和决策理由
4. **活文档**:文档随代码库演进,永不陈旧
5. **全自动**:所有操作由 AI 执行,无需用户手动操作
## 自动初始化
**当 AI 第一次接触项目时,必须自动执行:**
1. **检查项目状态**
- 检查是否存在 `.ai-context/` 目录
- 检查是否存在 `CLAUDE.md` 文件
- 检查是否存在 `AGENTS.md` 文件
2. **自动设置规则**
- 如果 `CLAUDE.md` 不存在,创建并追加强制规则
- 如果 `CLAUDE.md` 存在但缺少规则,追加规则
- 如果 `AGENTS.md` 不存在,创建并追加 Agent 规则
- 如果 `AGENTS.md` 存在但缺少规则,追加规则
3. **自动扫描代码库**
- 如果 `.ai-context/` 不存在,运行 `/docs-scan` 生成文档
4. **自动初始化工作流**
- 确保工作流日志存在
- 确保读取日志存在
**用户不需要执行任何手动操作,AI 会自动完成所有初始化。**
## 强制工作流(全自动)
**重要**:此工作流是强制性的,AI 必须自动执行,用户无需手动操作。
### 用户使用方式
用户只需要正常对话,例如:
- "帮我修改登录功能,添加记住密码"
- "修复认证模块的 bug"
- "重构数据库层"
**AI 会自动完成所有文档相关操作。**
### 代码变更前(AI 自动执行)
当用户请求修改代码时,AI 必须自动执行以下操作:
1. **自动识别影响范围**
- 分析要修改的文件
- 确定涉及的模块
- 确定涉及的功能
2. **自动读取相关文档**
- AI 自动查找并读取所有相关文档
- 包括:架构文档、编码规范、模块文档、功能文档、API 文档
- 读取会被自动记录和验证
3. **自动启动工作流**
- AI 自动执行:`bash ~/.claude/skills/code-documents-auto-skill/scripts/enforce-workflow.sh start -f "文件列表" -m "模块列表"`
- 工作流会话自动创建
4. **自动验证读取完成**
- AI 自动执行:`bash ~/.claude/skills/code-documents-auto-skill/scripts/enforce-workflow.sh check -f "文件列表"`
- 验证通过后才能编辑代码
### 代码变更后(AI 自动执行)
当代码修改完成后,AI 必须自动执行以下操作:
1. **自动记录变更**
- AI 自动执行:`bash ~/.claude/skills/code-documents-auto-skill/scripts/record-changes.sh "变更描述"`
- 生成完整的变更记录
2. **自动更新文档**
- 自动更新模块文档
- 自动更新功能文档
- 自动更新 API 文档
- 自动生成