AgentSkillsCN

docs-consistency

验证并修正文档内容,使其与实现保持一致。在更新文档、发布新版本,或当用户提到“docs consistency”“docs verify”“ドキュメント更新”“docsを直して”时使用此功能。

SKILL.md
--- frontmatter
name: docs-consistency
description: Verify and fix documentation to match implementation. Use when updating docs, releasing versions, or when user mentions 'docs consistency', 'docs verify', 'ドキュメント更新', 'docsを直して'.
allowed-tools: [Read, Edit, Grep, Glob, Bash]

Docs Consistency

ドキュメントは実装を説明するものであり設計を書き換えないため、設計意図→実装調査→差分検出→docs修正の順で更新する。

  1. 設計意図抽出docs/の設計書からWhat/Why/制約を読む
  2. 実装調査mod.ts(公開API), src/types/(型), src/core/(コア), src/validation/, src/replacers/を確認
  3. 差分検出 — 設計+実装 vs 現ドキュメントの差分表を作成(Gap列が空でなければ修正対象)
  4. docs修正 — 設計docsは変更せず、README.md → docs/user_guide.md → docs/api_reference.md の優先順で更新
  5. 検証grep "^export" mod.ts で公開APIとdocsの一致確認

言語: *.md=英語, *.ja.md=日本語