Skip to content
cccskills
FreePublished on GitHub

docs-audit

Comprehensive documentation audit and refresh. Checks code-documentation drift, generates prioritized report, then updates with approval. Use for: 'ドキュメント監査', 'docs audit', 'ドキュメント棚卸し', 'README全体見直し', 'documentation health check'.

The English summary is being prepared. Showing the original description.

See how to install

Files included (1)

  • SKILL.md2.3 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

Documentation Audit

ドキュメント全体を監査し、コードとの乖離を特定・修正する。

Workflow

Phase 1: 監査(自動)

Task tool (Explore agent) でコード-ドキュメント間の乖離を調査。

対象: README.md, CLAUDE.md, docs/*/.md, 設定ファイル

ファイル探索: git ls-files '*.md' でgit管理下のファイルを列挙する。Glob/Grepを使う場合は node_modules/, .git/, dist/, build/, coverage/ を必ず除外する。

チェック内容:

  • API/コマンド/設定の不一致(削除済み・未記載項目)
  • 存在しないファイル参照
  • 構造・依存関係の変化

出力: 優先度別分類(Critical/High/Medium/Low)+ ファイル:行番号

Phase 2: レポート

監査結果を優先度別に提示し、推奨アクションを示す。

Phase 3: 更新(承認後)

承認された問題をTask tool (general-purpose) で修正。

更新時の品質基準(@~/.claude/rules/code-quality.md Documentation Content セクション参照):

  • コンセプト優先: 目的・設計意図・使い方を書く
  • 陳腐化しやすい情報を避ける: ファイルツリー、タスクリスト、バージョン番号一覧等をハードコードしない
  • 自動導出可能な情報は書かない: tree、git ls-files、コード自体から得られる情報はドキュメントに複製しない
  • 既存の文体・フォーマットを維持

Variants

引数例動作
「レポートだけ」Phase 2で停止
「READMEだけ」スコープ限定
「設定との乖離だけ」特定カテゴリのみ

vs update-docs

スキル用途
update-docsコード変更に追従(コミット後)
docs-audit全体の健全性チェック(定期メンテ)

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Migrate existing ADRs to YAML frontmatter format. Scans docs/decisions/ for ADRs without frontmatter, infers status from body text, shows dry-run for approval. Trigger: /adr-migrate

The English summary is being prepared. Showing the original description.

berlysia/dotfiles9Updated Oct 21, 2026

Start or resume an ADR session. Without number: show status overview and recommend next actionable ADR. With number: provide phase-specific guidance. Trigger: /adr-session, /adr-session NNN, /adr-session new

The English summary is being prepared. Showing the original description.

berlysia/dotfiles9Updated Oct 21, 2026

Analyze a project's harness maturity and guide staged adoption of Harness Engineering best practices (quality loops, safety gates, linters, CLAUDE.md optimization).

The English summary is being prepared. Showing the original description.

berlysia/dotfiles9Updated Oct 21, 2026

bugfix

Free

Standardized bug fix workflow using TDD (Red-Green-Refactor). Use when fixing bugs, resolving issues, or when the user invokes /bugfix. Ensures root cause analysis, failing test first, then minimal fix.

The English summary is being prepared. Showing the original description.

berlysia/dotfiles9Updated Oct 21, 2026

Create detailed specifications by iteratively clarifying unclear points for Plan mode. Use when: After completing a plan when detailed requirements need clarification before implementation.

The English summary is being prepared. Showing the original description.

berlysia/dotfiles9Updated Oct 21, 2026

Policy-enforcing installer that deploys hardened Claude Code Action workflows (`@claude` manual mention + dependency-bot auto-fix) into a personal GitHub repository the user administers. Use when asked to introduce Claude Code Action, apply `@claude` mention support, or set up automated CI auto-fix for dependency bot PRs, using the security-hardened templates shipped with this skill.

The English summary is being prepared. Showing the original description.

berlysia/dotfiles9Updated Oct 21, 2026

See all skills by berlysia

Report a problem with this skill