クロスファンクショナルなアジャイルチームが執筆 • スプリント検証済み • レトロスペクティブ承認済み
「ドキュメントは速度を促進すべきであり、負債を生じさせるべきではない。」 — 当チームのテックリード
2週間ごとにリリースを行うアジャイルチームとして、次のようなドキュメントが必要でした:
3スプリント後の結論: OpenDocs + Pipeline = ドキュメント保守にかかる時間は40%削減、新メンバーのオンボーディングは3倍速くなった。
📁 プロジェクトアルファ(ルート)
├── 📄 プロダクトビジョンとOKR
├── 📁 アーキテクチャ
│ ├── 📄 システムコンテキスト図
│ ├── 📄 マイクロサービスマップ
│ └── 📄 データフロー(ライブDFD)
├── 📁 ユーザーストーリー
│ ├── 📄 エピック:ユーザー認証
│ └── 📄 受理基準テンプレート
├── 📁 スプリントアーティファクト
│ ├── 📄 スプリント12 レトロスペクティブ
│ └── 📄 ドンチェッキングリスト
└── 📁 ステークホルダーコミュニケーション
├── 📄 エグゼクティブサマリー(読み取り専用)
└── 📄 リリースノートアーカイブ
プロのヒント: Jira/Linearのプロジェクト構造をそのまま反映してください。これにより、タスク管理とドキュメントの間を切り替える際の認知負荷が軽減されます。
チームコメント: 「パイプラインで図面が更新された際、関連するOpenDocsページに微妙な『更新済』バッジが表示されるようにwebhook通知を設定しました。これで『これが最新版ですか?』というSlackのスレッドはもうありません。」 — サラ、スクラムマスター
Jiraチケットに静的なスクリーンショットを添付する代わりに:
## 技術的実装
{{pipeline:diagram-id-12345}}
> 💡 この図は、元となるモデルが変更されたときに自動更新されます。
> 最終同期日時:{{auto-timestamp}}
アジャイルの勝利:スプリント計画の際に、3スプリント前とは異なる現在の状態を反映するライブビジュアルを使ってアーキテクチャについて議論できる現在状態—3スプリント前のスクリーンショットではない。
リファインメント中に新しい機能についてアイデア出しをしているとき:
"次のシーケンス図を生成してください:
ユーザーが『チェックアウト』をクリック → システムがカートを検証 →
決済ゲートウェイが処理 → 注文確認メールを送信。
決済失敗時のエラー処理を含める。"
チームのコメント: 「図作成時間を45分から5分未満に短縮した。AIが約80%まで到達するので、残りの時間をエッジケースの調整に費やす。時間制限のあるリファインメント会議にとって大きな勝利だ。」— マーカス、バックエンドエンジニア
デモデーまたは経営陣向けの更新の際は:
"スプリント12デモ - 支払いフロー v2.3"以下の方法でアクセス:共有 → 共有履歴を閲覧:
| 共有の説明 | 種類 | 作成日 | 状態 | 操作 |
|---|---|---|---|---|
| スプリント10デモ – 認証フロー | ライブ | 3月15日 | ✅ 有効 | [リンクをコピー] |
| Q1アーキテクチャレビュー | 静的 | 2月28日 | ⚠️ 古いバージョン | [アーカイブ] |
| 投資家用資料 – システム概要 | ライブ | 1月10日 | ✅ 有効 | [埋め込みコード] |
振り返りの洞察: 「私たちは今、毎月の『技術的負債』スプリント中に共有履歴を確認しています。古いリンクをアーカイブすることで、混乱が70%減少しました。」 — プリヤ、プロダクトオーナー
「パイプラインは図のためのGitのようなものです。ついにバージョン履歴、ブランチ(フォルダ経由)、マージ可能なアーティファクトを持つことができるようになりました。」
— DevOpsエンジニア
「テキストコンテンツとライブ図が1つのエディタにあり、仕様書を書くためにタブを20回切り替えなくて済む。私のフローステートが感謝しています。」
— シニア開発者
「技術的でないステークホルダーも、何のインストールもせずにドキュメントを閲覧できます。デモ準備時間は2時間から20分に短縮されました。」
— プロダクトマネージャー
「パイプラインのアーティファクトに対して、早期に命名規則を設けるべきです。『Diagram_v2_final_revised』のような名前はスケールが大きくなると苦痛になります。」
— テックリード
「ライブ図は強力ですが、常に『最終更新日』のメモを追加してください。ステークホルダーは、リアルタイムデータを見ているかどうかを把握する必要があります。」
— QAエンジニア
「AI生成の図は素晴らしい出発点ですが、常にビジネスロジックを検証してください。AIが省略したエラーステートを発見しました。」
— ビジネスアナリスト
| 実践 | 手順 | アジャイルの利点 |
|---|---|---|
| ドキュメントをコードとして扱う | OpenDocsのエクスポート設定をリポジトリに保存する;ドキュメントをソースコードと同じように扱う | ドキュメントの変更に対してPRレビューを可能にする |
| スプリント終了時のドキュメント同期 | スプリントリトロで30分を確保して、図や仕様を更新する | ドキュメントの負債が蓄積されるのを防ぐ |
| 完了の定義 + ドキュメント | DoDチェックリストに「OpenDocsに埋め込まれた図」を追加する | ドキュメントが機能と同時に進化することを保証する |
✅ 効果的なプロンプト:
"ユーザーのオンボーディング用のBPMN図を作成する:
1. メール認証(並列ゲートウェイ:SSOの場合スキップ)
2. プロフィール設定(必須項目:名前、役割)
3. ウェルカムメールのトリガー
無効なメールとタイムアウトのエラーパスを含める。"
❌ 不明確なプロンプト:
"オンボーディング図を作成して"
プロのヒント:チームでの再利用のために、最も良いプロンプトを「AI図テンプレート」という名前のOpenDocsページに保存する。
#sprint12または#auth-epicパイプラインのコメントで、OpenDocsでの簡単なフィルタリングに使用する📁 機能別(プロダクトチームに推奨)
├── 📁 認証
│ ├── 📄 ユーザーストーリー:SSO統合
│ ├── 📄 シーケンス図(ライブ)
│ └── 📄 API契約(OpenAPI埋め込み)
📁 コンポーネント別(プラットフォームチームに推奨)
├── 📁 支払いサービス
│ ├── 📄 アーキテクチャ意思決定記録
│ ├── 📄 データモデル(ERD)
│ └── 📄 デプロイメント図
📁 スプリント別(急成長するスタートアップに推奨)
├── 📁 スプリント12
│ ├── 📄 目標と範囲
│ ├── 📄 デモスクリプト
│ └── 📄 レトロスペクティブアクション
スプリントレビューでこれらの項目を追跡する:
| 指標 | ベースライン | OpenDocs導入後 | 測定方法 |
|---|---|---|---|
| アーキテクチャドキュメントの更新にかかる時間 | 4時間/スプリント | 45分/スプリント | カレンダーの予約済みログ |
| ステークホルダーからの説明要求 | 週12件 | 週3件 | Slack/メールタグ分析 |
| 新入社員のオンボーディング時間 | 3週間 | 1.5週間 | HRフィードバック調査 |
| ドキュメント関連のバグ | スプリントあたり5件 | スプリントあたり1件 | Jiraラベル:「doc-mismatch」 |
✅ はい、以下の調整を加えれば
🔄 持続的改善バックログ:
「アジャイルでは、ドキュメント作成は段階ではなく、継続的な対話です。OpenDocsは、その対話を視覚的で知的で、常に同期された状態にできるツールを提供してくれます。」
— あなたのアジャイル・スクワッド
AIコンポーネント図ジェネレーター: OpenDocs更新: ソフトウェアアーキテクチャのコンポーネント図を生成する新しいAIツールについての更新。例と埋め込み活用事例を含む。