docs-archive - SKILL.md Agent Skill

name: docs-archive description: > 检测代码变更并归档文档。开发完成后运行。 user-invocable: true allowed-tools: - Read - Write - Edit - Bash - Glob - Grep

/docs-archive — 归档变更

当用户输入 /docs-archive 时，执行以下完整流程：

步骤 1：检测变更

使用 Bash 执行以下命令，全面了解代码变更：

# 查看变更统计
git diff --stat

# 查看变更文件列表（含状态）
git diff --name-status

# 查看未跟踪的新文件
git ls-files --others --exclude-standard

# 查看暂存区变更
git diff --cached --name-status

分析变更内容：

识别修改（M）、新增（A）、删除（D）的文件
按模块分类变更文件
识别变更类型（功能新增、bug修复、重构、配置变更等）

步骤 1.5：收集用户文档

检查用户是否提供了相关文档：

询问用户或检测是否有以下文档：

需求文档（PRD、需求规格说明等）
技术文档（技术方案、架构设计等）
测试报告（测试用例、测试结果等）
设计文档（UI 设计、流程图等）

如果用户提供了文档：

创建文档目录结构：

mkdir -p .ai-context/changelog/{文件夹名}/docs/requirements
mkdir -p .ai-context/changelog/{文件夹名}/docs/technical
mkdir -p .ai-context/changelog/{文件夹名}/docs/testing
mkdir -p .ai-context/changelog/{文件夹名}/docs/design
mkdir -p .ai-context/changelog/{文件夹名}/docs/other

复制或创建文档：
- 如果用户提供了文件路径，复制到对应目录
- 如果用户提供了内容，创建对应的 md 文件
- 如果用户口头描述，整理成文档保存

文档分类：

文档类型	存放目录	说明
需求文档	`docs/requirements/`	PRD、需求规格、用户故事
技术文档	`docs/technical/`	技术方案、架构设计、API 设计
测试报告	`docs/testing/`	测试用例、测试结果、性能报告
设计文档	`docs/design/`	UI 设计、流程图、数据库设计
其他文档	`docs/other/`	会议纪要、讨论记录等

步骤 2：生成变更记录

创建迭代文件夹 .ai-context/changelog/{YYYY-MM-DD-HHMMSS}-{变更标识}/，包含以下 6 个核心文档：

overview.md - 变更概述（背景、目的、类型）
files.md - 文件清单（代码、配置、文档）
technical.md - 技术细节（核心变更、技术决策）
impact.md - 影响范围（功能、性能、安全、兼容性）
testing.md - 测试验证（单元测试、集成测试、手动测试）
deployment.md - 部署信息（部署要求、验证步骤、回滚方案）

详细模板请参考 SKILL.md 中的完整说明。

步骤 3：更新 changelog 索引

更新 changelog/README.md 索引文件：

读取现有的 changelog/README.md
更新变更统计数据（总变更次数、各类型数量）
在"最近变更"表格中添加新记录
更新"按模块统计"和"按类型统计"

步骤 4：更新相关文档

必须检查并更新以下所有相关文档：

模块文档（modules/{模块}.md）
API 文档（api/{模块}.md）
数据库文档（database/README.md）
中间件文档（middleware/README.md）
架构文档（architecture.md）
编码规范（guidelines/coding-style.md）

步骤 5：输出归档摘要

✅ 归档完成！

---

## 📝 变更记录

**文件夹**: .ai-context/changelog/{日期}-{标识}/
**类型**: {feat/fix/refactor}
**概述**: {变更概述}

---

## 📄 更新的文档

| 文档 | 更新内容 | 更新原因 |
|------|----------|----------|
| changelog/README.md | 更新变更统计 | 新增变更记录 |
| modules/auth.md | 新增登录接口说明 | 新增了 AuthController.login() |

---

## 📊 变更统计

| 维度 | 数量 |
|------|------|
| 修改文件 | {数量} |
| 新增文件 | {数量} |
| 删除文件 | {数量} |
| 影响模块 | {数量} |
| 更新文档 | {数量} |

---

✅ 所有文档已同步，可以提交代码！