表示モード
運用設計書
| 項目 | 内容 |
|---|---|
| 文書番号 | OD-001 |
| 版数 | 1.0 |
| 作成日 | 2026-06-12 |
| 作成 | Claude Code(実装担当) |
| 承認 | けんぞ(PM) |
1. 運用の基本思想
運用の合言葉
「該当ディレクトリに md を置く」だけ。 手順が2つ以上に増えた瞬間に更新は止まり、wiki 廃墟化が再演される。
本書のすべてのルールはこの1点を守るためにある。
2. 更新フロー
2.1 人間が更新する場合
- 該当ディレクトリに md ファイルを作る(命名規則は 3 章)
- frontmatter に
title:を書く npm run docs:buildでビルドが通ることを確認(リンク切れはここで検出される)- デプロイする(
npx wrangler pages deploy docs/.vitepress/dist)
2.2 AI(Claude Code)が増築する場合
人間と同じフローを AI が代行する。指示の例:
「今日の定例の議事録を追加して」 → Claude Code が
05-meetings/2026-06-19-regular.mdを生成し、ビルド検証・デプロイまで実施
「課題 I-03 を完了にして」 →
06-issues/index.mdの該当行を更新し、再デプロイ
正本が md + git なので、AI への指示に特別な仕組みは不要。ここが Notion や Google Sites との決定的な違いであり、本システムの存在理由である。
3. 命名・記述規則
| 対象 | 規則 | 例 |
|---|---|---|
| ディレクトリ | NN-category(番号 + 英語) | 05-meetings/ |
| 文書ファイル | 英語スラグ。議事録など時系列文書は YYYY-MM-DD-slug.md | 2026-06-12-kickoff.md |
| frontmatter | title:(日本語)必須 | title: キックオフ議事録 |
| 文書ヘッダ | 文書番号・版数・作成日・作成・承認の表を冒頭に置く | 本書冒頭参照 |
| 変更履歴 | 文書末尾に版・日付・変更内容の表 | 本書末尾参照 |
| 装飾・図解 | VitePress 標準(コンテナ・Badge)と共通クラスのみ。インライン style 直書き禁止 | 規約の全体は基本設計書 6 章 |
4. レビュー運用
- 変更は git のコミット差分でレビューする(サイト側に承認ワークフローを作らない)
- AI が生成した文書は、人間(PM)が承認してからデプロイする
5. 廃墟化対策
| 施策 | 内容 | サイクル |
|---|---|---|
| 学び記録の即時追記 | ハマり・改修は学び・改修記録へその場で書く | 都度 |
| 課題の棚卸し | 課題管理表の全項目の状態を見直す | 月1回 |
| 構造の棚卸し | 使われていないディレクトリ・古い文書の整理 | 四半期1回 |
6. 障害時運用
| 事象 | 対応 |
|---|---|
| ビルド失敗 | ほぼリンク切れが原因。ビルドログの該当パスを修正する |
| 表示崩れ | 直前のコミットに git revert して再デプロイ(リリース計画書 4 章) |
| デプロイ失敗 | wrangler のログイン状態を確認(npx wrangler whoami) |
変更履歴
| 版 | 日付 | 変更内容 |
|---|---|---|
| 1.0 | 2026-06-12 | 初版作成 |
| 1.1 | 2026-06-12 | 記述規則に「装飾・図解」の行を追加(基本設計書 6 章と連動) |