docs-rewrite-all
`docs/**/*.md` + `README.md` + `CHANGELOG.md` を一括棚卸しし、 `.claude/rules/document-writing.md` と機械的に照合する。 領域別に C*O へ書き換えを委譲し、diff 提案 → CEO 承認 → 書換の 2 段階で自動マージを禁じる。`LICENSE` は除外する。 「/vibecorp:docs-rewrite-
SKILL.mdskills/docs-rewrite-all/SKILL.md
GitHub📖 docs-rewrite-all: ドキュメント全書き直しスキル
[!IMPORTANT] このスキルは diff 提案 → CEO 承認 → 書換の 2 段階を必須化 する。 自動マージは禁止する。 機械的書き直しで意味を壊さないための設計判断。
リポジトリ内のドキュメントを ドキュメント作成基準 に沿って一括で書き直し提案する。 書き換えそのものは行わず、必ず CEO 承認を経由する。
🎯 対象範囲
| 観点 | 内容 |
|---|---|
| 📂 対象パス | docs/**/*.md + README.md + CHANGELOG.md |
| 🚫 除外 | LICENSE(法的文書、書き換え対象外) |
| 📐 適用基準(本文) | .claude/rules/document-writing.md(ドキュメント本文の書き方基準) |
| 💬 適用基準(md 内コメント例) | .claude/rules/comment-writing.md(Issue/PR/レビュー/Bot 通知のコメント例を含む md の照合基準) |
| 🤝 委譲先 | 領域に応じた C*O Agent |
| 🔐 承認 | CEO 承認なしに書き換えない(2 段階必須) |
🧭 7 段階動線
このスキルは以下 7 段階を順に進める。
| ステップ | 名称 | 役割 |
|---|---|---|
| 1️⃣ | 列挙 | 対象ファイルを収集する |
| 2️⃣ | 照合 | 基準と機械的に突き合わせる |
| 3️⃣ | 委譲 | 領域別に C*O Agent を呼び出す |
| 4️⃣ | 提案 | diff を CEO に提示する |
| 5️⃣ | 承認 | CEO の判断を待つ |
| 6️⃣ | 書換 | 承認分のみファイルに反映する |
| 7️⃣ | レポート | 結果を CEO 向けに整形する |
各ステップは前段の出力を受け取り次段へ渡す。
ステップ 5(承認)でスキップが指示された項目は、ステップ 6 で書き換えない。
1️⃣ 列挙: 対象ファイル収集
対象ファイルを以下の手順で収集する。
find docs -type f -name '*.md' -print
ls README.md CHANGELOG.md
LICENSEは除外する(法的文書)。docs/migration/配下のような履歴アーカイブも対象に含める。- 履歴であっても読者がスキャンする可能性があるため。
- ファイル一覧を変数に保持し、ステップ 2 へ渡す。
2️⃣ 照合: 基準との機械的突き合わせ
ステップ 1 のファイル一覧を、以下 2 基準の 指針 MUST 全項目 と 禁止パターン全項目 に対して 1 件ずつ突き合わせる。
| 基準 | 照合対象 |
|---|---|
.claude/rules/document-writing.md |
ドキュメント本文(章立て・動作主語・スキャン性等) |
.claude/rules/comment-writing.md |
md 内に登場する GitHub コメント例(Issue/PR テンプレ例・レビュー例・Bot 通知例) |
照合対象の項目本体は各基準ルールが Single Source of Truth。
- 指針 / 禁止の項目本体は基準ルールに閉じる(スキル側で項目を重複列挙しない)。
- 各ファイルに対し「該当する基準項目(指針 N / 禁止 N)」と「該当行番号」を表で記録する。
- ドキュメント本文と md 内コメント例の両方を持つファイルは両基準で照合する。
- 検出結果が空のファイルはステップ 3 以降の対象から外す。
3️⃣ 委譲: 領域別 C*O Agent 呼び出し
各ファイルの 内容領域 に応じて、書き換え提案を担当する C*O を選ぶ。
領域 → C*O 対応表
| 領域 | 対象ドキュメント例 | 委譲先 |
|---|---|---|
| 🔒 セキュリティ | docs/SECURITY.md / セキュリティ仕様 |
CISO |
| 💰 コスト | docs/cost-analysis.md / 課金構造 |
CFO |
| 🛠️ 技術 | docs/specification.md / 設計判断 / アーキテクチャ |
CTO |
| ⚖️ 法務 | docs/POLICY.md / LICENSE 周辺 / 規約 |
CLO |
| 📦 プロダクト | README.md / docs/ai-organization.md / MVV 周辺 |
CPO |
| 🔄 変更履歴 | CHANGELOG.md |
CTO(リリース管理担当) |
領域が複数にまたがる場合は、主たる領域の C*O に委譲する。
判定に迷う場合は CPO に委譲する(プロダクト全体の窓口として)。
委譲方法
Agent ツールで該当 C*O を起動する。プロンプトは skills/docs-rewrite-all/prompts/agent-call-cxo-rewrite.md を参照する。
CO は複数並列で起動してよい(各 CO は別ファイルを扱うため競合しない)。
4️⃣ 提案: diff を CEO に提示
ステップ 3 で集めた書き換え案を、ファイル単位の diff として整形する。
提示時は以下を明示する。
- ✅ 適用候補: 基準逸脱を解消する書き換え。
- ⚠️ 要判断: 意味解釈の余地がある書き換え。
- 📍 根拠: 該当する指針 / 禁止項目の番号。
提示は ファイル単位 にまとめる。
- 全ファイルを一括提示すると CEO のレビュー負荷が高くなる。
- 1 ファイルずつ承認を取る運用を基本とする。
- CEO の指示で「まとめて見る」と言われた場合のみ複数ファイル同時提示に切り替える。
5️⃣ 承認: CEO 判断を待つ
CEO に以下の選択肢を提示する。
| 選択肢 | 効果 |
|---|---|
| ✅ 全採用 | 提示した diff を全て書き換え対象に取る |
| 🔢 項目選択 | 採用したい項目の番号を指定する |
| ⏭️ スキップ | このファイルの書き換えを保留する |
| ✋ 中止 | スキル全体を中止する |
承認なしに書き換えは行わない。
AskUserQuestion ツールで選択肢を明示提示してもよい(CEO の判断負荷を下げるため)。
6️⃣ 書換: 承認分のみファイル反映
ステップ 5 で承認された項目のみを Edit ツールで反映する。
書き換え後は以下を必ず実行する。
- 既存テスト一式を走らせる(ドキュメント参照を持つテストの破壊検出)。
- 該当する rule のテスト(
tests/test_*_rule.sh)を走らせる。 - 破壊が出た場合はその場で書き換えをロールバックし、CEO に報告する。
書き換えは ファイル単位の commit で行う(後追いで diff を追跡できるように)。
7️⃣ レポート: CEO 向け結果整形
以下のフォーマットで結果を CEO に返す。
## 📖 docs-rewrite-all 完了レポート
### 📊 集計
- 対象ファイル数: N 件
- 書き換え採用: M 件
- スキップ: S 件
- 中止: 0 / 1
### ✅ 採用された書き換え
- {ファイル名}: {変更の動作主語要約}(採用 K 件)
### ⏭️ スキップされた項目
- {ファイル名}: {スキップ理由}
### ⚠️ CEO 判断保留
- {ファイル名}: {判断保留の論点}
### 📍 次のアクション
- 必要に応じて `/commit` で書き換えをコミット
- 残課題は別 Issue で起票(`/issue`)
レポートは 動作主語(〜になった / 〜できるようになった)で書く(communication.md 規約)。
🤝 委譲先エージェント
このスキルは以下の C*O Agent を呼び出す。
| エージェント | 専門領域 |
|---|---|
cto |
技術・アーキテクチャ・リリース管理 |
cpo |
プロダクト方針・README・MVV |
cfo |
コスト・課金構造 |
ciso |
セキュリティ |
clo |
法務・ライセンス・規約 |
各 C*O は 管轄ファイルのみ 書き換え提案する。
🛡️ 制約
- 自動マージ禁止: CEO 承認なしに書き換えない(2 段階必須)。
- 意味改変禁止: 基準適合の整形のみ、意味を変えない。
- LICENSE 除外: 法的文書は本スキルの対象外。
- 既存テスト破壊禁止: 書き換え後にテストを走らせ、破壊があればロールバック。
- shell 規約: スクリプト記述は
.claude/rules/shell.mdを遵守する。 - autonomous-restrictions 準拠: 本スキルは自律改善ループ(
/vibecorp:diagnose→/vibecorp:autopilot→/vibecorp:ship-parallel)の自動実行対象外とし、人間(CEO)の明示承認を必須化する(.claude/rules/autonomous-restrictions.md)。
🔗 関連
- 適用基準(本文):
.claude/rules/document-writing.md - 適用基準(md 内コメント例):
.claude/rules/comment-writing.md - 動作主語ルール:
.claude/rules/communication.md - マークダウン規約:
.claude/rules/markdown.md - shell 規約:
.claude/rules/shell.md - 配置・言語ルール:
.claude/rules/documentation.md - 自律実行不可領域(人間承認必須):
.claude/rules/autonomous-restrictions.md - 類似多段動線スキル:
skills/sync-check/SKILL.md/skills/sync-edit/SKILL.md - 関連スキル:
/vibecorp:prompts-rewrite-all(プロンプト系.mdを扱う) //vibecorp:comments-rewrite-all(コード内コメントを扱う)