haru01

cga-docs-update

by @haru01 in Tools
0
0
# Install this skill:
npx skills add haru01/order_skills_sample --skill "cga-docs-update"

Install specific skill from multi-skill repository

# Description

|

# SKILL.md


name: cga-docs-update
description: |
コード変更に伴うドキュメント更新を提案・実行。git diff main..HEADを分析し、doc/domain/・doc/decisions/の更新が必要な箇所を特定して提案。ユーザー確認後に更新を実行。
Analyze code changes and propose/update documentation in doc/domain/ and doc/decisions/. Use when preparing PR, completing feature work, or ensuring doc-code consistency. Trigger: "update docs", "sync documentation", "check doc consistency".
allowed-tools: Bash Read Glob Grep Edit AskUserQuestion


いつ使うか

  • フィーチャーブランチの作業が一段落したとき
  • PRを作成する前
  • mainへマージする前のドキュメント整合性チェック

何をするか

  1. git diff main..HEAD でコード変更を分析
  2. 影響を受けるドキュメントを特定し、更新を提案
  3. ユーザー確認後、更新を実行

対象ドキュメント

doc/domain/(ユーザーストーリー・語彙)

観点 説明
進捗状況 実装済み機能の進捗率を更新
受け入れ条件 完了したタスクにチェックを入れる
技術タスク 追加・変更されたファイルを反映
エラー型定義 新しいエラー型が追加されていないか

doc/decisions/(意思決定記録)

観点 説明
新規ADR/DDR 重要な意思決定が記録されているか
既存DR更新 実装で判明した追加情報があるか

使用例

このスキルを発動する例:
- "ドキュメントを更新して"
- "Update documentation for my changes"
- "/cga-docs-update"
- "doc/domain/の進捗率を更新したい"
- "PRを出す前にドキュメントチェックして"

発動しない例(他のスキルを使うべき):
- "新しいDRを作りたい" → /cga-decision-record を使用
- "スキルのドキュメントを更新" → .claude/skills/は対象外

ワークフロー位置

フィーチャー実装 → /cga-docs-update → PR作成
                      ↓
            doc/domain/, doc/decisions/ を更新

関連スキル:
- /cga-decision-record - 新規DR作成(技術選定やドメインルール記録)
- /cga-programming - 実装実行(ドキュメント更新の前段階)

Troubleshooting

よくある問題

"変更がないのに更新提案される"
- git diff main..HEADで差分を確認してください
- mainブランチとの差分がない場合、スキルは何も提案しません

"更新すべき箇所が提案されない"
- 対象ディレクトリ: doc/domain/doc/decisions/のみ
- .claude/skills/の更新は対象外
- コード変更とドキュメントのマッピングを確認

"提案内容が過剰/不足している"
- スキルは実装状況との差分のみ提案します
- 未実装の機能を完了にマークすることはありません

"更新後にコンフリクトが発生"
- 更新前にmainブランチを最新化してください: git pull origin main
- 手動マージが必要な場合があります

詳細

guide.md を参照

# Supported AI Coding Agents

This skill is compatible with the SKILL.md standard and works with all major AI coding agents:

Learn more about the SKILL.md standard and how to use these skills with your preferred AI coding agent.