Skip to content
cccskills
FreePublished on GitHub

docs-sync

変更差分に追随してドキュメント(README / docs/ / AGENTS.md / SKILL.md)を更新する。ユーザーが「ドキュメント更新」「README 追随」「docs-sync」等を求めたとき、または実装変更で消えたフラグ・旧名・古い既定値がドキュメントに残っていると気づいたときに使用する。

差分から外部契約の語を抽出し、ヒットした箇所だけを更新する。

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

See how to install

Files included (1)

  • SKILL.md3.4 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

/docs-sync スキル

Goal

実装の変更差分に追随してドキュメントを更新し、消えたフラグ・旧名・古い既定値が残ったまま次の読み手(人間と AI)が古い前提で作業するのを防ぐ。

lint-changed(Stop フック)は構文とスタイルしか見ず、文面として古いだけの記述は素通りする。/review・/review-scan は差分そのものの妥当性を見る観点なので、差分に現れない既存ドキュメントの取り残しは対象外。その隙間を埋める。

Workflow

Step 1: 差分を確定する

  • 引数が base ブランチなら git diff --name-only <base>...HEAD、PR 番号なら gh pr diff <番号> --name-only で変更ファイルを取る
  • 引数が無ければ既定のベースブランチ(origin/HEAD → origin/main → origin/master の順)との三点 diff を使う
  • 差分が無ければ中断して報告する

Step 2: 外部契約の語を抽出する

差分の中身を読み、呼び出し側が依存する語だけを抜く。

  • 公開シンボル(関数・型・定数の名前)
  • CLI のサブコマンドとフラグ
  • 設定キー、環境変数、既定値
  • ファイルパス、タスク名

実装内部のローカル変数やコメントは対象にしない。

Step 3: 追随が必要な箇所を列挙する

  • 抽出語を README / docs/ / AGENTS.md / SKILL.md へ grep する(探索範囲はこの 4 種に固定する)
  • ヒットした箇所を「ファイル:行」と現在の記述で列挙する
  • ヒットが 0 件、または一般名詞で過多になった場合は書き換えず、列挙だけして止める

Step 4: 該当箇所だけを更新する

  • Step 3 で列挙した箇所に限定して書き換える。差分と無関係な文面は触らない
  • 載っているコード例とコマンドは実際に実行して、出力が記述と一致することを確かめる
  • 更新不要と判断した箇所は、理由を 1 行で報告する

Step 5: 検証して委譲する

  • verify-changed(リポジトリにあれば)または対応する Markdown リンタを走らせる
  • コミット・push・PR は commit-and-draft-pr へ渡す

Notes

  • 網羅を狙わない。対象は Step 2 の抽出語にヒットした箇所だけに限定する。差分と無関係な文面まで書き換えると、レビューで本題が埋もれる
  • 抽出語が一般名詞(config、run、path 等)のときはヒットが膨らむ。絞り込めないなら書き換えず列挙に留める
  • 差分が大きいほど読むドキュメントが増えるため、探索範囲は Step 3 の 4 種に固定する
  • ドキュメントの構成変更や新規ドキュメントの起案には踏み込まない。既存記述の追随だけを担う

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

Convert Claude markdown subagent files to Codex CLI TOML format. Parses YAML frontmatter and body, applies model/permission/tool mappings, and outputs to agents/codex/<name>.toml.

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

hodanov/my-pde3Updated Oct 18, 2026

Create or update a Markdown blog draft from recent work and export it with `YYYY-MM-DD_slug.md` naming. Output directory can be set via environment variable or CLI option; if missing, ask the user and pass it explicitly.

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

hodanov/my-pde3Updated Oct 18, 2026

変更をコミットしてドラフトPRを作成する一連のGit/ghワークフロー。ユーザーが「コミットして」「PR作って」「draft PR」等を求めたときに使用し、status/diff確認・命令形コミット・push・gh pr create --draft(--assignee hodanov)まで実行する。ユーザーの明示リクエストが無くても、実装完了後にcommitやPRが必要になった場面(dev-workflowのcommitフェーズ等)では必ずこれを使う。`git commit` や `gh pr create` を単体でBash直接実行しない。

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

hodanov/my-pde3Updated Oct 18, 2026

1 つの作業ツリーに混ざった差分を、変更理由ごとの意味単位のコミットへ分割する。ユーザーが「コミットを分割して」「意味単位で分けて」「commit-split」等を求めたとき、または機能追加・付随リファクタ・設定/ドキュメント修正が 1 コミットに混在していると気づいたときに使用する。分割案を提示して承認を得てからステージし、コミットごとに単独で成立することを確認する。メッセージ規約・push・PR の作成は commit-and-draft-pr へ委譲する。

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

hodanov/my-pde3Updated Oct 18, 2026

gitleaks + pre-commit を使ってローカルコミット時のクレデンシャル混入を機械的にブロックする。「クレデンシャル漏洩防止」「シークレット混入対策」「gitleaks」「pre-commit シークレット」「credential leak prevention」に言及した場合に使用する。

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

hodanov/my-pde3Updated Oct 18, 2026

依存パッケージ(Go modules / npm / Terraform provider / GitHub Actions / pre-commit 等)の アップグレードを、outdated 検出 → CHANGELOG・破壊的変更の確認 → 更新 → lint/test 検証 → コミットまで一連の手順で安全に適用する。「依存更新」「パッケージを上げて」「dependency update」 「go get -u」「npm update」「provider を上げる」等に言及されたときに使用する。

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

hodanov/my-pde3Updated Oct 18, 2026

See all skills by hodanov

Report a problem with this skill