Skip to content
Back to skills

I Doc Update

ASecurity

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

  • 15 stars
  • 0 votes
  • 0 copies
  • 0 views
  • Added October 1, 2026
ai-agentsbashgitdocumentation

Works with

  • cli

Security analysis

A100/100

Scanned October 1, 2026

npx -y skills add apokamo/kaji --skill i-doc-update --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of I Doc Update?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for I Doc Update
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/apokamo-i-doc-update/badge)](https://www.skillsdirectory.com/skills/apokamo-i-doc-update)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
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 → **update-doc** → review-doc → (fix-doc → verify-doc) → i-doc-final-check → i-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` はハーネス経由ではプロンプトに自動注入される(`prompt.py` 側で provider 別に整形)。手動実行時は `issue_id` から導出する: GitHub 数値 ID なら `#<issue_id>`、`local-*` 形式なら bare ID(`#` を付けない)。

## 前提知識の読み込み

1. [docs/dev/development_workflow.md](../../../docs/dev/development_workflow.md)
2. [docs/dev/docs_maintenance_workflow.md](../../../docs/dev/docs_maintenance_workflow.md)
3. [docs/dev/documentation_update_criteria.md](../../../docs/dev/documentation_update_criteria.md)
4. [docs/dev/shared_skill_rules.md](../../../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](../_shared/worktree-resolve.md) の手順に従い、
Worktree の絶対パスを取得すること。以降のステップではこのパスを使用する。

### Step 2: 設計書と Issue の確認

1. Issue 本文とコメントを確認
2. 設計書を確認(docs-only 運用では設計書は任意。存在する場合のみ参照する):
   ```bash
   # 設計書が存在する場合のみ表示。マッチが無くても失敗しない
   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](../../../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 全体の状態を確認する。

```bash
cd [worktree_dir] && source .venv/bin/activate && make verify-docs
```

- 今回の変更と無関係な既存エラーは、この Issue で無理に解消しない
- 無関係な既存エラーは別 Issue を作成して追跡する
- 全体チェック結果が大量エラーでレビュー可能性を損なう場合は、結果把握後に変更ファイル中心の確認へ切り替える

### Step 6: コミット

```bash
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 コメント

```bash
kaji issue comment [issue_id] --commit --body-file - <<'EOF'
## docs-only 更新完了

### 更新内容

- (更新したドキュメント)
- (関連 workflow / skill)

### 整合確認

- 実装 / workflow / 既存 docs / AGENTS.md / CLAUDE.md との整合を確認
- `make verify-docs` による初回全体リンクチェックを実施

### 次のステップ

`/i-doc-review [issue_id]` でレビューを実施してください。
EOF
```

## Verdict 出力

```text
---VERDICT---
status: PASS
reason: |
  docs-only の更新を完了した
evidence: |
  対象ドキュメントと関連 workflow/skills を更新し、現行実装・CLI・運用方針との整合を確認した
suggestion: |
---END_VERDICT---
```

### status の選択基準

| status | 条件 |
|--------|------|
| PASS | docs 更新完了 |
| ABORT | docs だけでは安全に対処できない |

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…