agentleFS
apokamoapokamo/kaji/.claude/skills/i-doc-update/SKILL.md

i-doc-update

Skill16 starsChanged 2 days agoApache-2.0View on GitHub

docs-only の更新を行う。コードやテストは変更せず、現行実装・CLI・運用方針との整合を確認しながら docs を修正する。

The file

Files
SKILL.md

I Doc Update

ドキュメント修正専用のスキル。 このスキルの目的は ドキュメントのみを更新すること である。コード、設定、テストは変更しない。 ただし、docs の記述が現行実装や運用方針と矛盾していないかは厳格に確認する。

いつ使うか

タイミングこのスキルを使用
docs-only Issue の主作業✅ 必須
コード変更を伴う Issue❌ issue-implement / i-dev-final-check を使用

ワークフロー内の位置: review-ready → start → update-doc → review-doc → (fix-doc → verify-doc) → i-doc-final-check → i-pr → close

入力

ハーネス経由(コンテキスト変数)

変数型説明
issue_idstr正規化済み Issue ID(GitHub 数値)
issue_refstr人間可読の Issue 参照(GitHub では #<issue_id>)
step_idstr現在のステップ ID

手動実行(スラッシュコマンド)

$ARGUMENTS = <issue_id>

解決ルール

コンテキスト変数 issue_id が存在すればそちらを使用。 なければ $ARGUMENTS の第1引数を issue_id として使用。

issue_ref はハーネス経由ではプロンプトに自動注入される(prompt.py 側で provider 別に整形)。手動実行時は issue_id から #<issue_id> を導出する。

前提知識の読み込み

  1. docs/dev/development_workflow.md
  2. docs/dev/docs_maintenance_workflow.md
  3. docs/dev/documentation_update_criteria.md
  4. docs/dev/shared_skill_rules.md
  5. docs/README.md
  6. README.md
  7. 変更対象 docs と関連する実装、workflow、設計書、運用ドキュメント

ガードレール

  • コード、設定、テストは変更しない
  • 事実確認のための read / search / 最小限のコマンド確認は許可
  • make verify-docs による全体確認は許可
  • docs だけでは解決できない不整合を見つけた場合は ABORT

実行手順

Step 1: Worktree 情報の取得

_shared/worktree-resolve.md の手順に従い、 Worktree の絶対パスを取得すること。以降のステップではこのパスを使用する。

Step 2: 設計書と Issue の確認

  1. Issue 本文とコメントを確認
  2. 設計書を確認(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
  3. 変更対象 docs と expected outcome を整理

Step 3: 整合性監査

docs/dev/documentation_update_criteria.md の 3 観点(事実整合性・実装整合性・運用整合性)に沿って、最低限以下を確認する。

  • docs/ の記述が現行コードと矛盾していないか
  • AGENTS.md / CLAUDE.md のコマンド、禁止事項、運用ルールと矛盾しないか
  • docs/dev/development_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 コメント

verdict マーカーの無条件付与(必須): 判定コメントには 常に --verdict-step doc-update --verdict-status <STATUS> を付ける。<STATUS> は本 skill が「Verdict 出力」で返す status(PASS / ABORT)に置き換える。CLI が body 1 行目に <!-- kaji-verdict: step=doc-update status=<STATUS> --> を付け、kaji issue resolve-verdict --step doc-update と runner の comment fallback はこの marker で発行元 step を特定する。PASS でも省略しない(条件付きの付与は禁止。docs/dev/shared_skill_rules.md § verdict マーカー契約)。投稿前に判定を確定してから status を決める。

kaji issue comment [issue_id] --commit \
  --verdict-step doc-update --verdict-status <STATUS> \
  --body-file - <<'EOF'
## docs-only 更新完了

### 更新内容

- (更新したドキュメント)
- (関連 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条件
PASSdocs 更新完了
ABORTdocs だけでは安全に対処できない

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.