docs-sync について
docs-sync は `/speckit.implement` の完了後、実装内容や仕様ファイルをもとにプロジェクト文書を更新します。README.md、CHANGELOG.md、API ドキュメントを整え、マーカー外の内容は保持します。
主な機能
- 01README.md の使用法と機能を更新
- 02CHANGELOG.md に項目を追加
- 03API ドキュメントを同期
- 04マーカー外の内容を保持
- 05変更ファイルと差分の概要を報告
活用シーン
- 01実装後のドキュメント更新
- 02完了した作業の変更履歴への記録
- 03API ドキュメントと契約の整合
- 04文書の更新内容とエラーの確認
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/docs-syncを入力して読み込まれたか確認します。
同梱ファイルscripts/sync.sh
詳細
docs-sync
/speckit.implement の完了後に、ドキュメントを実装に合わせて同期します。
目的
このスキルは、実装された機能を反映するようにドキュメントを自動更新します。次の処理を行います。
- README.md を更新：実装の詳細を含む使用方法のセクションを追加／更新します
- CHANGELOG.md を更新：新機能や変更のエントリを追加します
- API ドキュメントを更新：API ドキュメントをコントラクトと同期します
- ユーザーのコンテンツを保持：speckit マーカーの外にあるコンテンツは変更されません
マーカーシステム
docs-sync は、HTML コメントマーカーを使用して、自動生成されたセクションを区切ります。
Auto-generated content here
これらのマーカーの外にあるコンテンツは、完全にそのまま保持されます。
出力
このスキルは、次の内容を示す DocsSyncResult を出力します。
- 作成、更新、または変更されなかったファイル
- 各ファイル内で変更されたセクション
- 差分の概要（追加／削除／変更された行数）
- 発生したエラー
使用方法
このスキルは /speckit.implement の後に自動的に実行されます。手動で実行することもできます。
npx skills run docs-sync
終了コード
| コード | 状態 | 意味 |
|---|---|---|
| 0 | 成功 | すべての更新に成功しました |
| 1 | 部分的 | 一部の更新に失敗しました |
| 3 | エラー | 必須ファイルが見つかりません |
更新されるセクション
README.md
| セクション | マーカー | コンテンツソース |
|---|---|---|
| 使用方法 | `` | spec.md のユーザーストーリー |
| インストール | `` | plan.md の依存関係 |
| 機能 | `` | spec.md の機能要件 |
CHANGELOG.md
| セクション | マーカー | コンテンツソース |
|---|---|---|
| 未リリース | `` | tasks.md の完了済みタスク |
保持ルール
- 最初のマーカーより前のコンテンツは常に保持されます
- 最後のマーカーより後のコンテンツは常に保持されます
- 異なるマーカーペアの間にあるコンテンツは常に保持されます
- 対応するマーカーペア内のコンテンツのみが更新されます
- マーカーがない場合は、新しいマーカーとコンテンツが追加されます
エラー処理
- マーカーがない場合：新しいマーカーを作成してコンテンツを追加します
- マーカーの形式が不正な場合：エラーを報告し、そのセクションをスキップします
- ファイルのアクセス権限：エラーを報告し、ほかのファイルの処理を続けます
- ソースファイルがない場合：利用できないソースを報告します
コメント
Markdown 対応