| description | docs-only の更新を行う。コードやテストは変更せず、現行実装・CLI・運用方針との整合を確認しながら docs を修正する。 |
| name | i-doc-update |
I Doc Update
ドキュメント修正専用のスキル。
このスキルの目的は ドキュメントのみを更新すること である。コード、設定、テストは変更しない。
ただし、docs の記述が現行実装や運用方針と矛盾していないかは厳格に確認する。
いつ使うか
| タイミング | このスキルを使用 |
|---|
| docs-only Issue の主作業 | ✅ 必須 |
| コード変更を伴う Issue | ❌ issue-implement / i-dev-final-check を使用 |
ワークフロー内の位置: review-ready → start → doc-update → doc-review → (doc-fix → doc-verify) → final-check → pr → close
入力
ハーネス経由(コンテキスト変数)
| 変数 | 型 | 説明 |
|---|
issue_id | str | 正規化済み Issue ID(GitHub 数値または local ID) |
issue_ref | str | 人間可読の Issue 参照(GitHub では #<issue_id>、local では bare ID) |
step_id | str | 現在のステップ ID |
手動実行(スラッシュコマンド)
$ARGUMENTS = <issue_id>
解決ルール
コンテキスト変数 issue_id が存在すればそちらを使用。
なければ $ARGUMENTS の第1引数を issue_id として使用。
issue_ref はハーネス経由ではプロンプトに自動注入される(harness 側で provider 別に整形される)。手動実行時は issue_id から導出する: GitHub 数値 ID なら #<issue_id>、local-* 形式なら bare ID(# を付けない)。
前提知識の読み込み
- docs/dev/kaji-workflow.md
- docs/dev/documentation_update_criteria.md
- docs/dev/shared_skill_rules.md
docs/README.md
README.md
- 変更対象 docs と関連する実装、workflow、設計書、運用ドキュメント
ガードレール
- コード、設定、テストは変更しない
- 事実確認のための read / search / 最小限のコマンド確認は許可
make verify-docs による全体確認は許可
- docs だけでは解決できない不整合を見つけた場合は
ABORT
実行手順
Step 1: Worktree 情報の取得
_shared/worktree-resolve.md の手順に従い、
Worktree の絶対パスを取得すること。以降のステップではこのパスを使用する。
Step 2: 設計書と Issue の確認
- Issue 本文とコメントを確認
- 設計書を確認(docs-only 運用では設計書は任意。存在する場合のみ参照する):
shopt -s nullglob
files=([worktree_dir]/draft/design/issue-[issue_id]-*.md)
if (( ${#files[@]} > 0 )); then
cat "${files[@]}"
else
echo "[i-doc-update] no draft design file for issue [issue_id] (skipping)"
fi
- 変更対象 docs と expected outcome を整理
Step 3: 整合性監査
docs/dev/documentation_update_criteria.md
の 3 観点(事実整合性・実装整合性・運用整合性)に沿って、最低限以下を確認する。
docs/ の記述が現行コードと矛盾していないか
AGENTS.md / CLAUDE.md のコマンド、禁止事項、運用ルールと矛盾しないか
docs/dev/kaji-workflow.md と workflow/skill 構成が一致しているか
- links、参照パス、コマンド例が壊れていないか
Step 4: docs 更新
必要なドキュメントだけを更新する。
Step 5: 全体リンクチェック
初回に以下を実行し、既存 docs 全体の状態を確認する。
cd [worktree_dir] && source .venv/bin/activate && make verify-docs
- 今回の変更と無関係な既存エラーは、この Issue で無理に解消しない
- 無関係な既存エラーは別 Issue を作成して追跡する
- 全体チェック結果が大量エラーでレビュー可能性を損なう場合は、結果把握後に変更ファイル中心の確認へ切り替える
Step 6: コミット
cd [worktree_dir] && git add docs/ README.md .kaji/wf/ .claude/skills/ .agents/skills/ && git commit -m "docs: update for [issue_ref]"
必要に応じて変更対象パスを絞ってよい。
Step 7: Issue コメント
uv run kaji issue comment [issue_id] --commit --body-file - <<'EOF'
- (更新したドキュメント)
- (関連 workflow / skill)
- 実装 / workflow / 既存 docs / AGENTS.md / CLAUDE.md との整合を確認
- `make verify-docs` による初回全体リンクチェックを実施
`/i-doc-review [issue_id]` でレビューを実施してください。
EOF
Verdict 出力
---VERDICT---
status: PASS
reason: |
docs-only の更新を完了した
evidence: |
対象ドキュメントと関連 workflow/skills を更新し、現行実装・CLI・運用方針との整合を確認した
suggestion: |
---END_VERDICT---
status の選択基準
| status | 条件 |
|---|
| PASS | docs 更新完了 |
| ABORT | docs だけでは安全に対処できない |