Skills · Claude Code · Agent Skills

文档是「完成」的一部分——不容妥协。

在 CI 中测试的 docs-as-code、每个真实决策都有 ADR、从代码生成的 API 文档,一切都持久保存在归档与索引中。坏掉的文档是 bug。

v0.1.0Ferramenta · Documentaçãogithub.com/schematizeme/skill-docs

维护者 Lucas Andrade

schematize-docs · v0.1.0bash
$ schematize install docs
GitHub →下载技能 (.zip)/docs-help · github.com/schematizeme/schematize-cli

不可妥协的底线

绝不为“求快”而关闭。完整清单见技能。

文档是 DoD 的一部分

文档写在完成定义(DoD)里,而不是收尾时的附加项。

每个决策都有 ADR

每个相关的架构决策都成为带版本的 ADR:proposed → accepted/rejected,绝不留下孤立的 proposed。

docs-as-code,在 CI 中测试

文档住在仓库里、在 PR 中评审并被测试——能打开的链接、能运行的示例、能编译的片段。坏掉的文档是 bug。

从代码生成

尽可能从代码生成 OpenAPI 3.1 的 API 文档;带 SemVer 的 changelog 并记录 breaking change。

持久保存在归档与索引

一切都落到归档与索引/MAP——审计与 overdev 所消费的踪迹;根目录保持干净。

清晰且最小

没人读的文档是负债,不是资产——砍掉无用的部分。

命令

安装在 .claude/commands/。随时运行 /docs-help。

/docs-adr在 docs/adr/ 中创建或推进 ADR(proposed → accepted/rejected),含背景/决策/备选/后果;绝不留下孤立的 proposed。
/docs-api尽可能从代码生成/校验 API 文档(OpenAPI 3.1/契约),检查规范与实现之间的漂移,并维护 changelog + SemVer。
/docs-ccContext compact:将上下文和清单写入归档并运行 /compact。
/docs-claude在仓库根目录创建或合并常开的 docs CLAUDE.md(不覆盖其他技能的区块)。
/docs-handoff生成上下文交接而不压缩——会话结束或任务切换。
/docs-help列出所有命令。
/docs-load强制加载全部规范:纪律、ADR、runbook、API/版本管理、索引/图表。
/docs-runbook为服务/事件搭建或更新运维 runbook(症状 → 诊断 → 处置 → 验证 → 回滚 → 升级)。

面向 AI 智能体

无需人工即可安装。元数据见 llms.txt。

  • 运行:git clone https://github.com/schematizeme/skill-docs.git && ./skill-docs/install.sh
  • 或下载:https://github.com/schematizeme/skill-docs/releases/latest/download/skill-docs.zip 并解压到 .claude/skills/
  • 将 assets/CLAUDE.md 复制到仓库根目录(常开规则)。
  • 用 /docs-help 确认。

不想安装?

阅读完整规范并直接复制到你的项目——或安装该技能,让智能体自动执行。