Skip to content
cccskills
FreePublished on GitHub

update-docs

コード変更からドキュメントを追従更新する。設計書ファースト原則の例外措置。やむを得ず先にコードを変更した場合にのみ使用する。

「さっきの変更をドキュメントに反映して」「設計書を最新にして」 「コードと設計書がズレてるから直して」「ドキュメントを最新化して」 「ドキュメント更新して」「設計書を現状に合わせて」などのリクエストで使用する。通常はドキュメントを先に更新してからコードを修正すること(revise-specを使う)。

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

See how to install

Files included (1)

  • SKILL.md5.7 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

ドキュメントの追従更新(例外措置)

※ これは「設計書ファースト」原則の例外措置です。通常はrevise-specでドキュメントを先に更新してからコードを修正する。

本スキルは親=変更箇所特定・方針・レビュー / spec-writer(Sonnet)=ドキュメント書き換え / integrity-checker=機械的整合性検査の三者分担で進める。

引数の解釈

  • HEAD~1 → 直前のコミットとの差分
  • HEAD~3 → 直近3コミット分の差分
  • コミットハッシュ → そのコミット単体の変更
  • 引数なし → ステージされた変更(git diff --cached)

統一基盤の確認

Spec 統一基盤確認 を実施する。

手順

フェーズ1: 変更箇所の特定(親エージェント)

  1. コードリポで git diff を実行し、変更内容を把握する
  2. spec-map.yml を読み、変更されたファイルパスに一致するエントリからSpec IDを特定する
    • spec-map.yml に該当パスがない場合は新規REQ-IDの採番を提案する
  3. 2段階探索 でdiffに含まれない関連ファイルも探索する
  4. 変更の種別と影響範囲を整理する:
    • 更新対象ドキュメントの一覧(要件定義書・基本設計・openapi.yaml)
    • 各ドキュメントの該当セクション・箇所の特定
    • 差分の具体的な値(変更前 → 変更後)

フェーズ2: 執筆プラン整理(親エージェント)

  1. 以下を整理し、spec-writer へ渡す委任プロンプトを組み立てる:
    • 更新対象ファイルと更新箇所(セクション・行レベルで特定)
    • 変更前後の具体的な値(diffから抽出)
    • 差分更新の方針(全面書き換えではなく該当セクションのみ更新)
    • 新規REQ-IDが必要な場合はその採番値

フェーズ3: 書き換え委任(spec-writer)

  1. Agent(subagent_type: spec-writer) に更新を委任する:

    • 更新対象ファイルが複数かつ独立している場合は並列委任

    委任プロンプト形式:

    あなたは spec-writer です。以下のドキュメントを差分更新してください。
    
    ## 更新対象
    docs/requirements/features/[REQ-ID].md
    
    ## 更新箇所
    - セクション名: [XXX]
    - 変更前: [値]
    - 変更後: [値]
    - コード根拠: [ファイル名:シンボル名]
    
    ## 更新方針
    - 差分更新が基本。既存文書の全面書き換えはしない
    - 変更箇所のセクションだけを更新し、周辺は触らない
    - 不明点は「※ 要確認」マーカーを残し、推測で埋めない
    
    ## ヒアリング結果サマリ
    [フェーズ1で整理した変更内容]
    
    ## 厳守事項
    - index系ファイル(overview.md / spec-map.yml / mkdocs.yml / dependency-graph.md)は触らない(親が更新)
    - 完了時に軽量セルフチェックを実行し、結果を報告すること
    

フェーズ4: index系更新(親エージェント)

spec-writer は index 系に触らないため、親が責任を持って更新する:

  1. ドキュメントを新規作成した場合は mkdocs.yml の nav に追加する
  2. spec-map.yml 操作ガイド に従い spec-map.yml を同期する
  3. OVERVIEW同期チェック: 変更内容がOVERVIEW同期トリガー(spec-management.mdルール参照)に該当する場合、docs/requirements/overview.md も更新する
  4. docs/design/dependency-graph.md が存在し変更対象に新規Specがある場合、依存関係を追記する

フェーズ5: レビューと整合性チェック(親エージェント)

  1. spec-writer が更新したドキュメントを本体が直接レビューする(Agent委任不可)
    • diffの具体的な値がドキュメントに反映されているか確認(grep検証)
    • 要確認マーカーの確認と対応
  2. Agent(subagent_type: integrity-checker) を起動して機械的整合性チェック
    • 変更ファイルリスト・新規REQ-ID(あれば)を prompt で渡す
    • チェック項目: .claude/skills/_shared/doc-integrity-check.md 参照
    • 小さな変更でも integrity-checker を通す(リンク切れ・Mermaid 崩れ防止)
    • FAIL があれば修正 → 再チェック(最大3ループ)

フェーズ6: コミット(親エージェント)

  1. 変更を git add してコミット

フェーズ7: 次ステップ提案

  1. 次のステップを提案(「他に反映すべき変更はありますか?」)

ルール

  • 変更がSpec IDに紐づかない場合は新規REQ-IDの採番を提案する
  • 同じ定数・バリデーション値を参照している箇所も漏れなく更新する

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

既存プロジェクトに新しいリポジトリを追加する。Workspaceにリポを追加した後、 CLAUDE.md・設計書・ドメイン構成を差分更新する。 「モバイルリポを追加した」「新しいリポを取り込んで」「リポを追加したので設計書を更新して」 「Workspaceにリポを足した」などのリクエストで使用する。 init-spec の移行モードではファイル存在チェックしか行わないため、 既存ドキュメントの内容を新リポに合わせて拡張するにはこのスキルを使う。

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

i-standard1/yamasaki6Updated Aug 26, 2026

既存プロジェクトをサブエージェントで並列分析し、 精度の高い overview.md を生成する。init-spec の前処理として使う。 「既存プロジェクトを分析して」「コードベースを理解して設計書を作って」 「overview.mdを作って」などのリクエストで使用する。 ファイル数が200を超えるプロジェクトで特に有効。 200以下の場合は単一エージェントで全体を読む方が精度が高いため、 init-spec をそのまま実行することを提案する。

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

i-standard1/yamasaki6Updated Aug 26, 2026

デザインの差し替え。ロジックは一切触らず見た目(HTML/CSS/テンプレート)だけを更新する。 「このデザインに差し替えて」「UIをFigmaの通りに変えて」「見た目だけ変えて」 「デザインを更新して」「CSSだけ直して」などのリクエストで使用する。 ロジック変更を伴う場合はrevise-specを使う。

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

i-standard1/yamasaki6Updated Aug 26, 2026

browse

Free

ブラウザで画面を確認する。agent-browser CLI を使って画面のスクリーンショット撮影、 アクセシビリティツリー取得、フォーム操作、画面遷移などを行う。 「画面見て」「ブラウザ確認して」「スクショ撮って」「現状把握して」「画面開いて」 「ログインして確認して」「画面の状態を教えて」「UIを確認して」などのリクエストで使用する。 E2Eテストの作成・実行には gen-tests(Playwright)を使うこと。本スキルはテスト実行ではなく 「AIの目」としてブラウザを操作し、画面状態を把握するためのもの。

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

i-standard1/yamasaki6Updated Aug 26, 2026

ClaudeDesign(claude.ai/design)とClaude Codeの連携。DesignSyncツールで デザインプロジェクトからプロトタイプHTML等を取得(インポート)、または ローカルのコンポーネントをデザインシステムプロジェクトへ同期(プッシュ)する。 「ClaudeDesignからデザインを取得して」「claude.ai/design のURLを取り込んで」 「デザインプロジェクトに同期して」「デザインシステムをプッシュして」 などのリクエスト、または claude.ai/design のURLが渡されたときに使用する。 取得したデザインのコード実装への適用は apply-design を使う。

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

i-standard1/yamasaki6Updated Aug 26, 2026

詳細設計書の一括生成。2つのモードを自動判定する: (A) コード分析モード: 既存コードから詳細設計書を逆生成する(init-spec + spec-all 完了後) (B) 設計書ファーストモード: 要件定義書から詳細設計書を新規作成する(コードなし) 「詳細設計を作って」「設計書を完成させて」「実装に必要な設計書を全部作って」 「他のエンジニアに渡せる設計書にして」などのリクエストで使用する。

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

i-standard1/yamasaki6Updated Aug 26, 2026

See all skills by i-standard1

Report a problem with this skill