com um clique
docs
活文档维护。智能分析项目代码,维护 docs/ 核心文档和 README.md,包含健康检查、自动更新、质量评分功能。用户提到更新文档、同步文档时使用。
Instalar com Codex ou Claude Copie este prompt, cole no Codex, Claude ou outro assistente e deixe que ele revise a página da skill e instale para você.
Menu
活文档维护。智能分析项目代码,维护 docs/ 核心文档和 README.md,包含健康检查、自动更新、质量评分功能。用户提到更新文档、同步文档时使用。
Instalar com Codex ou Claude Copie este prompt, cole no Codex, Claude ou outro assistente e deixe que ele revise a página da skill e instale para você.
Baseado na classificação ocupacional SOC
个人笔记记录助手。自动以 JSON 格式记录想法、学习笔记、会议纪要到 ~/.note,支持标签分类和全文搜索。
对话归档技能。将当前对话流程提取并生成可重用的 skill 文件。
行为驱动开发(BDD)流程助手。用 Given-When-Then 描述验收标准,包含 Feature 文件管理、步骤定义实现。用户提到 BDD、验收测试、Gherkin 时使用。
GitHub CLI 专家助手,提供 gh 命令的场景化指导。用户提到 gh、GitHub CLI、创建 PR、管理 Issue 时使用。
Commit 历史整理与合并。将 TDD 循环产生的多个细碎 commit 合并为有意义的功能 commit,包含安全检查、交互式 rebase 指导。用户提到 squash、整理 commit 时使用。
测试驱动开发(TDD)流程助手。严格遵循红-绿-重构循环,包含会话状态管理、测试运行策略、Git 提交规范。用户提到 TDD、测试先行、红绿重构时使用。
| name | docs |
| description | 活文档维护。智能分析项目代码,维护 docs/ 核心文档和 README.md,包含健康检查、自动更新、质量评分功能。用户提到更新文档、同步文档时使用。 |
| user-invocable | true |
代码即真相,文档跟随代码
智能分析项目代码,维护 docs/ 核心文档和 README.md
/docs # 健康检查(默认)
/docs file # 更新指定文件
/docs init # 初始化文档骨架
/docs score # 质量评分
执行 /docs 显示文档健康状态:
📊 文档健康状态
| 文档 | 状态 | 最后更新 | 相关代码变更 |
|------|------|----------|-------------|
| CLAUDE.md | ✅ 新鲜 | 今天 09:30 | 无 |
| README.md | ✅ 新鲜 | 2天前 | 无 |
| docs/architecture.md | ⚠️ 过时 | 今天 14:30 | src/auth.py 新增 OAuth |
/docs init
自动创建:
docs/
├── architecture.md # 架构设计
├── components.md # 组件清单
├── development.md # 开发指南
├── testing.md # 测试策略
└── contributing.md # 贡献指南
| 代码变更 | 自动更新 |
|---|---|
| 新增模块 | components.md |
| 修改导入关系 | architecture.md |
| 修改配置文件 | development.md |
| 新增测试 | testing.md |
/docs # 更新所有过时文档
/docs docs/architecture.md # 更新指定文档
/docs --preview # 预览变更
/docs score
输出:
📊 文档质量评分
| 维度 | 得分 | 目标 | 状态 |
|------|------|------|------|
| 覆盖度 | 75% | ≥80% | ⚠️ |
| 新鲜度 | 60% | ≥70% | ❌ |
| 完整性 | 85% | ≥80% | ✅ |
总体评分: C+ (79.5/100)
| 文件 | 维护方式 | 内容 |
|---|---|---|
CLAUDE.md | /init | 项目指令、工作流 |
README.md | /docs | 项目概述、安装 |
docs/architecture.md | /docs | 系统架构、模块关系 |
docs/components.md | /docs | 组件清单、职责边界 |
| 场景 | 前缀 | 示例 |
|---|---|---|
| 更新核心文档 | docs: | docs: 更新架构文档 |
| 更新项目指令 | chore: | chore: 更新 CLAUDE.md |
文档过时 = 项目失活