syncdocs

Syncdocs：ドキュメント内のあらゆる事実の仕様はコードです

ドキュメントには、コードで正誤を確認できる事実と、人が判断するしかない文章という、2種類のテキストがあります。このスキルの基本方針は、事実はすべて、記述する前にコードから読み直し、それ以外には一切手を加えないことです。 バージョンはマニフェストから、コマンドはスクリプトから、ディレクトリ構成は ls から、機能はそれを実装するファイルから確認します。文章、語調、セクションの順序は執筆者のままにし、コードで正誤を確認できない主張は編集せず、担当者に確認します。

このスキルを保守するエンジニアが、自身のリポジトリで実施しているドキュメント確認作業をもとに作成しました。provenance.md に記録があります。

使用する場面

バージョン、依存関係、スクリプト、構成、機能を変更した後など、ドキュメントが実情と一致しなくなっている可能性がある場合、リリース前、またはドキュメントの正確性を確認するよう依頼された場合に使用します。

呼び出し方法	意味
/syncdocs	作業ディレクトリ内の既存ドキュメントをすべて同期し、報告した後、ドキュメントファイルをコミットします
/syncdocs check	確認して報告するのみです。編集もコミットもしません
/syncdocs <path>	<path> にあるリポジトリを対象にします

ユーザーの指示は既定の動作より優先されます。「コミットしないで」「差分を確認したい」「教えてくれるだけでいい」と指示された場合は、依頼どおりコミットしない、または編集しません。指定されたリポジトリが存在しない場合は、公開 URL からスクラッチディレクトリにクローンします。この評価において、そのクローンとパッケージレジストリは外部サービスには該当しません。対象ではない作業ディレクトリは、報告ファイルを求められた場合を除き、元の状態のままにします。

使用しない場面

代わりに行うこと	使用するもの
変更履歴の作成、またはバージョンの更新	bumpv
プロジェクトの慣例に沿ったコミット	commit
仕様としてのドキュメントに照らしてコードを確認	code-audit
まだ存在しない README、CLAUDE.md、ガイドの作成	依頼に応じてドキュメント作成スキル

アーキテクチャ

discover docs --> README.md, CLAUDE.md, AGENTS.md, docs/** (only what exists)
      |
ground truth  --> manifest + lockfile, scripts/targets/CI, ls, the implementing file
      |
compare       --> each claim: accurate | stale (code says X) | unverifiable
      |
sync          --> targeted edits to stale facts, the same fact equal in every file
      |
report        --> changed / verified accurate / flagged
      |
commit        --> doc files only, "docs: sync documentation with codebase state"

境界となるのは対象リポジトリそのものです。バージョンはマニフェスト、コマンドはスクリプトとターゲット、ディレクトリ構成はディレクトリ自体で決まり、リポジトリ固有のコミット規約と変更履歴の管理者は、それぞれ commit と bumpv の担当です。adaptation.md はありません。この段落がその役割を果たします。

重要な事実

1. 宣言された範囲は、インストール済みのバージョンではありません。 "next": "^16.2.0" は多くのリリースを許容します。どのバージョンが解決されたかはロックファイルに記載されています。ドキュメントで特定のバージョンを記載する場合はロックファイルに従い、範囲またはメジャーバージョンを記載する場合はマニフェストに従います（ground-truth.md）。
2. リポジトリで定義されていないコマンドは、ドキュメントに記載されていても実行できません。 lint スクリプトがなければ、読者が npm run lint を初めて実行した時点で失敗します。その行を残すには、該当するスクリプト、ターゲット、または CI ステップが存在していなければなりません。
3. ドキュメントに記載されたディレクトリ構成も、ほかの記述と同じく主張の一つです。 README を誰も編集していない間にディレクトリが移動することがあるため、構成のセクションは ls と追跡対象ファイルから再構築し、ドキュメント自身のディレクトリ構成は参照しません。
4. エージェントへの指示ファイルは、読むのではなく実行されます。 CLAUDE.md と AGENTS.md はエージェントに実行内容を指示します。古いコマンドはセッションのたびに実行されるため、こうしたファイルを最初に確認し、必要最低限の内容に保ちます。
5. すべてのファイルで、一つの事実には一つの値を使います。 複数のドキュメントに記載されているバージョンやコマンドは、同じ作業で全て同期するか、食い違いを報告します。事実の同期が不完全だと、新たな古い情報が生まれます。
6. マニフェストのないリポジトリにも、信頼できる情報源はあります。 Markdown のみのリポジトリでは、変更履歴の最新セクション、追跡対象ファイル、Git タグが事実です。変更履歴は読み取りますが、編集しません。

厳守事項

根拠となる情報はコードにあり、ドキュメントや記憶にはありません。 記載する値はすべて、このセッションでマニフェスト、ロックファイル、スクリプト、ターゲット、CI ファイル、または ls から読み取ったものにしてください。

変更するのは事実だけです。 古くなった事実は、対象を絞ってその箇所で修正してください。文章を書き直したり、セクションを並べ替えたり、スタイルを変更したり、バッジ、セクション、機能を追加したりしないでください。

存在しないドキュメントは作成しないでください。 README.md、CLAUDE.md、AGENTS.md、docs/ は、すでに存在する場合にのみ同期してください。存在しないファイルは作成せず、レポートで追加を提案してください。

CHANGELOG.md には決して触れないでください。 bumpv はコミット履歴から CHANGELOG.md を生成します。docs: コミットが同期の記録になります。

検証できない主張は、黙って残したり削除したりせず、要確認として報告してください。 ファイル、ルート、フラグが見つからない機能や、判断が必要な削除は、担当者が確認できるようレポートに記載してください。

古い情報がなければ、編集もコミットもしないでください。 ドキュメントが正確であることを伝えて終了し、コミットを正当化するための見た目だけの変更は行いません。

コミットするのはドキュメントファイルのみです。ユーザーから事前レビューの依頼がない場合に限り、AI による帰属表示は付けません。 コミットメッセージは docs: sync documentation with codebase state とし、モデル名やツール名を記載した Co-Authored-By: トレーラー、生成元を示す行、セッションへのリンクは付けないでください。コミット後に git log -1 --format=%B を確認してください。

クイックスタート

1. エージェントのフォルダー（.claude/ など）とベンダー提供のコピーを除き、存在するドキュメントを一覧にして、それぞれ全文を読みます。同期手順の「検出」を参照してください。
2. リポジトリ内のマニフェスト、スクリプト、ツリー、実装ファイルから根拠となる情報を確認します。根拠情報を参照してください。
3. すべての事実に関する主張を、正確、古い情報、検証不能に分類し、ファイルごとに古い情報をその箇所で修正します。同期手順を参照してください。
4. 変更点、検証済みの項目、要確認の項目を報告し、ユーザーの指示に従ってドキュメントファイルをコミットするか、終了します。レポートを参照してください。

リファレンスディレクトリ

シナリオ	トリガーとなるキーワード	リファレンス
各情報の根拠	package.json、lockfile、pyproject.toml、Cargo.toml、go.mod、Makefile、justfile、CI、scripts、ls、宣言された範囲、解決されたバージョン、マニフェストなし	ground-truth.md
各ドキュメントの編集	README.md、CLAUDE.md、AGENTS.md、docs/、対象を絞った編集、文章、構造ツリー、機能に関する主張、ファイル間の整合性	syncing.md
ユーザーへの報告とコミット	レポート、変更点、検証済み、要確認、確認モード、事前レビュー、コミットメッセージ、帰属表示	reporting.md
情報の出所	出所、修正済み、意図的に維持、追加済み	provenance.md

兄弟スキルを一覧にした Timerise Skills インデックスの一部です。