| description | docs-only の変更をレビューし、事実整合性・実装整合性・運用整合性の観点から判定する。 |
| name | i-doc-review |
I Doc Review
重要: このスキルは更新を行ったセッションとは別のセッションで実行することを推奨します。
CRITICAL: このレビューの目的は文章を整えることではない。現行実装との差異、古い手順、誤誘導となる記述を発見すること。
docs-only の変更をレビューする。新規指摘を行ってよい。
いつ使うか
| タイミング | このスキルを使用 |
|---|
i-doc-update 完了後 | ✅ 必須 |
ワークフロー内の位置: doc-update → doc-review → (doc-fix → doc-verify) → final-check → pr
入力
ハーネス経由(コンテキスト変数)
| 変数 | 型 | 説明 |
|---|
issue_id | str | 正規化済み Issue ID(GitHub 数値または local ID) |
issue_ref | str | 人間可読の Issue 参照(GitHub では #<issue_id>、local では bare ID) |
step_id | str | 現在のステップ ID |
cycle_count | int | 現在のイテレーション |
max_iterations | int | サイクルの上限回数 |
手動実行(スラッシュコマンド)
$ARGUMENTS = <issue_id>
解決ルール
コンテキスト変数 issue_id が存在すればそちらを使用。
なければ $ARGUMENTS の第1引数を issue_id として使用。
issue_ref はハーネス経由ではプロンプトに自動注入される(harness 側で provider 別に整形される)。手動実行時は issue_id から導出する: GitHub 数値 ID なら #<issue_id>、local-* 形式なら bare ID(# を付けない)。
前提知識の読み込み
- docs/dev/documentation_update_criteria.md
- docs/dev/shared_skill_rules.md
実行手順
Step 1: コンテキストの取得
- _shared/worktree-resolve.md の手順に従い、Worktree の絶対パスを取得
- Issue コメントから直近の docs-only 更新報告を確認
- 設計書があれば確認(docs-only workflow では設計書は任意。無くてもよい):
ls [worktree_dir]/draft/design/issue-[issue_id]-*.md >/dev/null 2>&1 \
&& cat [worktree_dir]/draft/design/issue-[issue_id]-*.md \
|| echo "(設計書なし: docs-only では任意)"
- 差分を確認:
cd [worktree_dir] && git diff main...HEAD
Step 2: レビュー
docs/dev/documentation_update_criteria.md
の 3 観点(事実整合性・実装整合性・運用整合性)で厳格にレビューする。
- 現行実装と一致しているか
- CLI コマンド例が現行仕様と一致するか
AGENTS.md / CLAUDE.md の運用方針と矛盾しないか
- workflow / skill / docs 間で記述が矛盾しないか
- リンク切れ、古いパス、読者導線の破綻がないか
Step 3: 変更ファイル限定リンクチェック
変更された Markdown ファイルに絞って以下を実行する。
cd [worktree_dir] && python3 scripts/check_doc_links.py [changed-markdown-files...]
Step 4: 結果を Issue にコメント
Must Fix / Should Fix を整理して Issue にコメントする。
Verdict 出力
---VERDICT---
status: RETRY
reason: |
docs の整合性レビューで修正事項が見つかった
evidence: |
実装との差異、運用方針との不一致、または読者を誤誘導する記述を確認した
suggestion: |
Issue コメントの指摘に従って `i-doc-fix` で修正すること
---END_VERDICT---
status の選択基準
| status | 条件 |
|---|
| PASS | 修正不要で i-doc-final-check へ進める |
| RETRY | docs 修正で解決可能 |
| ABORT | docs-only の範囲を超える重大な問題 |