SKILL

doc-maintenance

对照近期 git 历史审计 README、SPEC 和 PRODUCT 文档的漂移,并进行可直接提交 PR 的最小修改。适用于核对文档准确性、重要功能合并后检查或按计划审计。

译文已校对
查看英文原文

Audit README, SPEC, and PRODUCT docs against recent git history for drift and make minimal PR-ready edits. Use when asked to review docs for accuracy, after major feature merges, or on a schedule.

适用对象:软件开发与测试。自动收录 · 待核查。

原作者说明节选

从固定版本的 SKILL.md 提取,保留原文语言。以下内容属于作者说明,本站尚未验证安装、兼容或运行结果。

查看英文原文

原文涵盖的主题

  • Doc Maintenance Skill
  • When to Use
  • Target Documents
  • Workflow
  • Step 1 — Detect what changed
  • Step 2 — Classify changes
  • Step 3 — Build a change summary
  • Step 4 — Audit each target doc

Detect documentation drift and fix it via PR — no rewrites, no churn. Periodic doc review (e.g. weekly or after releases) After major feature merges When asked "are our docs up to date?" When asked to audit README / SPEC / PRODUCT accuracy | Document | Path | What matters | |----------|------|-------------| | README | README.md | Features table, roadmap, quickstart, "what is" accuracy, "works with" table | | SPEC | doc/SPEC.md | No false "not supported" claims, major model/schema accuracy | | PRODUCT | doc/PRODUCT.md | Core concepts, feature list, principles accuracy | Out of scope: DEVELOPING.md, DATABASE.md, CLI.md, doc/plans/, skill files, release notes. These are dev-facing or ephemeral — lower risk of user-facing confusion. Find the last review cursor: Then gather commits since the cursor: Scan commit messages and changed files. Categorize into: Feature — new capabilities (keywords: feat, add, implement, support) Breaking — removed/renamed things (keywords: remove, breaking, drop, rename) Structural — new directories, config changes, new adapters, new CLI commands Ignore: refactors, test-only changes, CI config, dependency bumps, doc-only changes, style/formatting commits. The

这里只展示节选,请以完整原文和当前要求为准。

来源仓库
paperclipai/paperclip
源文件
.agents/skills/doc-maintenance/SKILL.md
固定版本
1ca3e8ea2a759e511ab2d2659339c6c770a7a2ba
阅读完整原作者说明 ↗

来源与内容状态

本条为自动发现的元数据,尚未完成人工文档核查;适用性与运行结果待核查。

原作者:paperclipai/paperclip · 原作者仓库元数据。文档核查:未核查。最近来源检查:2026-11-10T02:01:27.152Z。

分类由名称、说明与路径规则生成,分类不代表已核实适配。

许可与权利归属

MIT。第三方内容及版权归原作者,使用条件以原文为准。

许可原文 ↗

本站没有因同步、复制或用户自报成功而将资源标为运行验证通过。

限制与注意事项

  • 元数据收录不代表本站已经安装、适配、实测或进行安全审查。