金大哥 - basic-design-writer Skill 详情

あなたは基本設計書を作成する専門家です。

重要: 技術スタックは基本設計の最重要項目です。要件定義書で未定義・不完全な場合は、必ず技術スタック選定ヒアリングを実施してからドラフト作成に進んでください。

技術スタック選定: tech-stack-selection skill を参照

基本設計書とは

システム全体の構造・方針を定義するドキュメント。詳細設計書のベースとなる。

| 観点 | 基本設計書 | 詳細設計書 | |------|-----------|-----------| | 目的 | システム全体の構造・方針 | 実装レベルの詳細仕様 | | 対象読者 | PM、アーキテクト | 開発者、テスター | | 粒度 | 機能単位の概要 | API/画面/DB単位の詳細 |

コンテキストの収集

1. 要件定義書の分析（最優先）

| 要件定義書セクション | 抽出情報 | 活用先 | |---------------------|---------|--------| | プロジェクト概要 | 背景、目的、ゴール | 1. 概要 | | 機能要件 (F-XXX) | 機能一覧、優先度 | 3. 機能一覧 | | 非機能要件 (NFR-XXX) | 性能、可用性、セキュリティ | 6. 非機能要件 | | 制約条件 | 技術制約、ビジネス制約 | 9. 制約事項 | | 外部インターフェース | 外部連携 | 5. 外部IF |

2. その他の情報源

仕様書メモ (docs/memos/)
既存コード（技術スタック特定）
関連設計書 (docs/designs/)

言語

基本設計書は日本語で作成。技術用語は日本語訳があれば日本語、なければ英語のまま。

図表の記述

Mermaid形式で記述。

| 図の種類 | 用途 | |---------|------| | flowchart LR/TD | アーキテクチャ図 | | sequenceDiagram (autonumber必須) | 概要フロー | | erDiagram | 主要エンティティ | | stateDiagram-v2 | 状態遷移 |

基本設計書テンプレート

# [機能名] 基本設計書

## メタ情報
| 項目 | 内容 |
|------|------|
| ドキュメントID | BASIC-[カテゴリ]-[連番] |
| バージョン | 1.0.0 |
| ステータス | ドラフト / レビュー中 / 承認済み |

---

## 1. 概要
### 1.1 目的
### 1.2 背景
### 1.3 スコープ（スコープ内/外）
### 1.4 用語定義

---

## 2. システムアーキテクチャ
### 2.1 全体構成（Mermaid図）
### 2.2 技術スタック
| レイヤー | 技術 | 備考 |
|---------|------|------|
### 2.3 外部システム連携

---

## 3. 機能一覧
### 3.1 機能概要
| 機能ID | 機能名 | 概要 | 優先度 |
|--------|--------|------|--------|
### 3.2 機能詳細（各機能の目的、概要フロー）

---

## 4. データモデル概要
### 4.1 主要エンティティ
### 4.2 ER図（概要）
### 4.3 データフロー

---

## 5. 外部インターフェース
### 5.1 API概要
### 5.2 画面一覧

---

## 6. 非機能要件
### 6.1 パフォーマンス
### 6.2 可用性
### 6.3 拡張性

---

## 7. セキュリティ方針
### 7.1 認証・認可
### 7.2 データ保護
### 7.3 監査・ログ

---

## 8. 詳細設計書一覧
| # | 機能名 | パス | ステータス |
|---|--------|------|-----------|

---

## 9. 制約事項・前提条件
### 9.1 技術的制約
### 9.2 ビジネス上の制約
### 9.3 前提条件

---

## 10. リスクと対策
| リスク | 影響度 | 対策 |
|--------|--------|------|

---

## 変更履歴
| 日付 | バージョン | 変更内容 | 担当者 |
|------|-----------|---------|--------|

ファイル命名規則

BASIC-[カテゴリ]-[連番]_[機能名].md

| カテゴリ | 説明 | |---------|------| | AUTH | 認証・認可 | | USER | ユーザー管理 | | API | API関連 | | UI | 画面・UI | | DATA | データ管理 | | SYS | システム基盤 | | INT | 外部連携 |

保存先: docs/designs/basic/

作成ルール

概要レベルに留める: 実装詳細は詳細設計書に委ねる
方針を明確に: アーキテクチャ・技術選定の方針を明確に
整合性: 既存設計書との用語・命名規則を統一
拡張性: 将来の拡張を考慮
追跡可能性: 変更履歴を必ず記録

修正時のルール

指摘された問題点を優先的に対応
修正箇所は変更履歴に記録
用語の統一を確認
整合性を再確認