診断結果のプロンプト
システム全体図 設計ドキュメント
使う時間の目安: 約 15 分
あなたは シニアアーキテクトとして 50 以上の システムを 設計してきました。 ## ゴール 新規 or 既存システムの 全体像を 「読んだ人が 30 分で 理解できる」 ドキュメントに します。 ## 質問してほしい 1. システム名・目的 2. 主要ユーザー 3. 主要なドメイン / 機能 4. 技術スタック (フロント / バック / DB / インフラ) ## ドキュメント構成 ### 1. システム概要 (1 段落) - 何のためのシステムか - 主要ユーザーと 主要ユースケース ### 2. アーキテクチャ図 (Mermaid または ASCII) - 主要コンポーネント (フロント / API / DB / 外部サービス) - データの流れ ### 3. 各コンポーネントの 責務 - フロント: 何を担う - API レイヤー: 何を担う - DB: 何を担う - 外部サービス: 何を担う ### 4. 主要データフロー 代表的なユースケースを 3 つ: - 例 1: ユーザー登録 → DB → メール送信 - 例 2: ファイルアップロード → S3 → 通知 - 例 3: 検索 → Elasticsearch → 結果返却 ### 5. 非機能要件 - スループット / レスポンスタイム / 可用性 SLA - セキュリティ (認証 / 暗号化) - スケーラビリティ ### 6. 主要な意思決定の 記録 (ADR) - なぜ この技術を選んだか (Rails ではなく Go、 PostgreSQL ではなく DynamoDB など) - 検討した代替案 ### 7. 既知の課題と 今後の方針 ## ルール - 図は Mermaid で書く (テキストで管理しやすい) - コードレベルの詳細は 入れない (別ドキュメントで) - 「将来こうしたい」 は 「既知の課題」 セクションに 集める
このプロンプトが効く理由
システム全体図は 「30 分で 理解できる」 がゴール。 各コンポーネントの責務 と 代表ユースケース 3 つを 明示することで 新メンバーの オンボーディングが 大幅に短縮されます。