---
doc_id: DOC-DDG-OV
title: "工程別ドキュメント運用ガイド — Overview"
doc_kind: dev_docs_guide_note
category: overview
status: confirmed
owner: 資料編集
source_type: specification
chapter: "overview"
badge: "目次 · 全章"
html: "../index.html"
note_file: "Overview.md"
related:
  requirements: []
  systems: []
  screens: []
  tables: []
  business_rules: []
tags:
  - dev-docs-guide
  - overview
updated: "2026-07-13"
---

# 工程別ドキュメント運用ガイド — Overview

> HTML版: [../index.html](../index.html)

> [!abstract] 資料の読み方
> 工程別ドキュメント運用ガイドの **Obsidian 用ノート** です。立場別に章を選んで読んでください。ブラウザ版は同フォルダの `../index.html` から開けます。

## ねらい

「品質のために時間がかかる」のではなく、**正本を1か所に集約することで品質と速度が同時に上がる**ことを、各章の Before/After で示します。

## 立場別ルート

| 立場 | 推奨ルート |
| --- | --- |
| 経営層 | [[00_経営層向け]] → [[07_PM・情報共有]] → [[08_マスタサマリー]] |
| PM | [[00_経営層向け]] → [[07_PM・情報共有]]。ゲート前は **01・05・06** |
| SE | [[01_要件定義]] → [[02_基本設計・ADR]] → [[03_API・OpenAPI]] → [[05_テスト・QA]]。引き継ぎは **06** |
| PG | [[03_API・OpenAPI]] → [[04_実装]]（3層エージェント文書 · 4役割 · Agent-native CI/CD） |
| AI運用 | [[04_実装]]（開発PC 4役割）→ [[06_運用]] → [[10_Hermes_PMO_AIPC]] → [[11_Quality_Signals_Loop]] |

## 2026-06 追記 — エージェント運用（調査反映）

| トピック | 章 |
| --- | --- |
| IDE 内4役割（開発PC） | [[04_実装]] |
| **PMO AIPC**（社内ノウハウ蓄積 MCP Server） | [[04_実装]] · [[06_運用]] · [[10_Hermes_PMO_AIPC]] |
| Agent-native CI/CD | [[04_実装]] · [[05_テスト・QA]] |
| Quality Signals Loop | [[11_Quality_Signals_Loop]] · [[08_マスタサマリー]] |
| 開発PC直置き Hermes | **非推奨**（個人検証のみ） |

> [!warning] Hermes は Cursor の透明中継ではなく**記憶・整流レイヤー**。実装=Cursor、レビュー=Codex。

## SSOT の流れ

```mermaid
flowchart LR
  SSOT["正本<br/>Git / MD / OpenAPI"]
  INT["社内・AI・実装"]
  CUST["レビュー用HTML/PDF"]
  AUD["監査・ADR"]
  QX["品質 × 効率<br/>1か所更新 → 全体同期"]
  SSOT --> INT
  SSOT --> CUST
  SSOT --> AUD
  SSOT --> QX
```


## Markdown 正本 + YAML 構造化索引

章ノート（`notes/`）と実案件正本（`starter_kit/docs/`）は **Markdown が一次資料**。AI・ゲート・トレーサ向けに `knowledge/*.yaml` で**構造化索引**を持つ。YAML は正本の**代替ではない**。

| 索引 | パス | 内容 |
| --- | --- | --- |
| ガイド章 | [knowledge/chapters.yaml](../knowledge/chapters.yaml) | 章メタ · 読者 · HTML リンク |
| ガイド施策 | [knowledge/practices.yaml](../knowledge/practices.yaml) | Before/After · 推奨モデル |
| 実案件 REQ | [starter_kit/knowledge/requirements.yaml](../starter_kit/knowledge/requirements.yaml) | REQ 索引 · source_refs |
| 手順 | [tools/extract_knowledge_from_markdown.md](../starter_kit/tools/extract_knowledge_from_markdown.md) | 抽出 · 検証 · レポート |

> [!warning] 禁止
> Markdown を YAML に置き換える · 出典なしで `confirmed` · 索引だけ更新して正本を放置

詳細: [index.html の説明](../index.html#knowledge-index-pack) · [[01_要件定義]] · [[08_マスタサマリー]]


> [!tip] PDF配布
> **[[08_マスタサマリー]] + [[00_経営層向け]]** をブラウザ印刷（「背景のグラフィック」をオン）するのがおすすめです。

## 章一覧

| 章 | 概要 | 技術・キーワード | ノート | HTML |
| --- | --- | --- | --- | --- |
| 0. 経営層向け | 品質×効率の ROI。Before/After・KPI 定義・PoC baseline・ゲート判断の3分サマリー。 | `SSOT · KPI · gate-decision · open-items · PDF配布` | [[00_経営層向け]] | [00_executive.html](../00_executive.html) |
| 1. 要件定義 | REQ-ID 付き Markdown 正本。Mermaid 分岐・曖昧語ゲート・依頼者向けレビュー HTML（非正本）。 | `REQ-*.md · Mermaid · open-items.md · requirements-definition-gate · 二層（MD+HTML）` | [[01_要件定義]] | [01_requirements.html](../01_requirements.html) |
| 2. 基本設計・ADR | 技術選択の理由を ADR に残す。C4 / 状態遷移・却下案の記録で手戻りを減らす。 | `adr/ADR-*.md · design.md · C4 · Mermaid · v0（UIたたき台）` | [[02_基本設計・ADR]] | [02_design.html](../02_design.html) |
| 3. API・OpenAPI | 契約の正本は分割 YAML。CI で bundle・schema diff・型生成の整合を取る。 | `OpenAPI 3.x · paths/components · bundle · Orval · openapi-diff · Swagger UI` | [[03_API・OpenAPI]] | [03_api.html](../03_api.html) |
| 4. 実装 | AGENTS.md + SOP + スキルの3層。AI役割設計（知識蒸留）· 既存CI/CD×AI · Agent-native CI/CD。 | `AGENTS.md · docs/sop/ · Copilot instructions · Jenkins/GHA · PR-Agent · 品質定義テンプレ` | [[04_実装]] | [04_implementation.html](../04_implementation.html) |
| 5. テスト | TestDesignDoc と traceability.csv で REQ↔TC 網羅。障害・変更から観点を還流。 | `TestDesignDoc.md · traceability.csv · REQ-ID · LLM-as-a-Judge（補助）` | [[05_テスト・QA]] | [05_testing.html](../05_testing.html) |
| 6. 運用 | Runbook MD 正本。PMO AIPC · BTS（Redmine）判断履歴 · CI/CD×AI連携の運用記録。 | `runbooks/ · PMO AIPC · Redmine REST · CI結果追跡 · 週次 PM` | [[06_運用]] | [06_operations.html](../06_operations.html) |
| 7. PM・共有 | 週次 PM・着手ゲート・版間意味逸脱監査。合意索引と open-items の鮮度維持。 | `gate-decision.md · semantic-drift-audit · weekly PM · baseline-agreements` | [[07_PM・情報共有]] | [07_pm.html](../07_pm.html) |
| 8. マスタサマリー | 全工程1枚。RACI・変更マトリクス・週次チェック・AI 役割要約。経営配布用。 | `RACI · 変更マトリクス · 週次チェックリスト · 4役割要約` | [[08_マスタサマリー]] | [08_summary_sheet.html](../08_summary_sheet.html) |
| 9. 参考リンク | 外部読み物・スターターキット索引。note / MetaCTO / ASDLC / Hermes / Zylos 等。 | `note · MetaCTO · ASDLC · ai-requirements-factory · Hermes · Agent-native CI/CD` | — | [09_references.html](../09_references.html) |
| 10. Hermes / PMO AIPC | Hermes を社内ノウハウ蓄積 MCP Server として扱うかの限定採用判断。開発PC直置き非推奨・ADR未決を明示。 | `Hermes Agent · Ollama · MCP Server · PMO AIPC · allowlist · draft/approved` | [[10_Hermes_PMO_AIPC]] | [10_hermes_pmo_aipc.html](../10_hermes_pmo_aipc.html) |
| 11. Quality Signals Loop | PR・CI・eval・週次レビューを接続し、人の記録漏れだけに依存せず問題を検知する。 | `Required Checks · eval · DORA · postmortem · observability` | [[11_Quality_Signals_Loop]] | [11_quality_signals_loop.html](../11_quality_signals_loop.html) |


## パック構成

| パス | 内容 |
| --- | --- |
| `index.html` | **唯一の HTML 入口** — 目次・読み方 |
| `notes/Overview.md` | Obsidian 目次（Markdown 正本） |
| `knowledge/` | 章・施策の YAML 索引 |
| `starter_kit/` | 実運用テンプレ（`knowledge/` 含む） |
| `09_references.html` | 外部リンク集 |

## Markdown 正本 + YAML 索引

- 章正本: `notes/` · 索引: `knowledge/chapters.yaml` 等
- 実案件: `starter_kit/docs/` 正本 · `starter_kit/knowledge/` 索引
- 手順: `starter_kit/tools/extract_knowledge_from_markdown.md`

## 15分で始める

1. `starter_kit/` をプロジェクトへコピー
2. `AGENTS.md` の Commands を編集
3. `REQ-TEMPLATE.md` から要件起票
4. `.cursor/rules/dev-docs-ssot.mdc` 有効化
5. 曖昧語スキャン・ゲートスキル実行

詳細: [スターターキット](../starter_kit/README.md)


> **実運用:** [index.html](../index.html) · [スターターキット](../starter_kit/README.md)




## 成果物マップ（全工程）

| 工程 | 主な成果物 |
| --- | --- |
| 提案 | `baseline-agreements.md` · 提案サマリー.html |
| 要件 | `REQ-xxx.md` · `review/*.html` · glossary |
| 設計 | `design.md` · `adr/ADR-xxx.md` · C4.mmd |
| API | `openapi/**/*.yaml` · bundled · Redoc |
| 実装 | `AGENTS.md` · PR · 生成型 |
| テスト | `TestDesignDoc.md` · `traceability.csv` |
| 運用 | `runbooks/*.md` · `CHANGELOG` |
| PM | `open-items.md` · `gate-decision.md` |
| 索引 | `knowledge/*.yaml` · `schemas/` · `reports/`（MD 正本の構造化索引） |

各章ノート末尾に具体サンプル（ファイル名・抜粋）があります。



---

**ナビ:** [[Overview]] · [[00_経営層向け]] →