# 基本設計（API設計・DB設計）

要求・要件が固まったら、実装のもとになる**基本設計書**を作ります。左メニュー「計画・設計」の「**基本設計**」から管理します。

![PM on Railsの基本設計。API / DBの叩き台が見える。導入前は設計が口頭とスライドに散らばっていた。導入後はストーリーから展開したたたき台を人が確認する。](https://pmonrails.com/docs-img/basic-design.png)

## 設計書の種類

| 種別 | 中身の目安 |
| --- | --- |
| **API設計書** | エンドポイント一覧・リクエスト / レスポンス・シーケンス図 |
| **DB設計書** | ER図・テーブル定義の概要・キー / インデックス方針 |
| **画面設計書** | 画面の一覧・遷移・項目 |

基本設計の画面では、設計書をジャンル別のフォルダで管理します。DB設計・API設計・画面設計・帳票設計などのジャンルがあり、自由に追加できます。一覧には、名前・共有範囲・更新日・種類が並びます。

## 作り方

- 右上の「設計書を作成」から新規作成します。中身は[ナレッジ](https://pmonrails.com/docs/knowledge.md)のドキュメントと同じ仕組みで、**版管理・レビュー / 承認・検索**がそのまま使えます。
- **AIで叩き台を作る** — 新規作成画面の「AIで書く」から右側のチャットを開き、ひな形や図の種類を選ぶと、プロジェクトの要求カードや要件を参照してエンドポイント表・ER図などの下書きを生成できます（確認・編集してから保存）。
- **mermaid図が描ける** — 本文に ```mermaid のコードブロックを書くと、**ER 図（`erDiagram`）やシーケンス図（`sequenceDiagram`）が図として表示**されます。DB設計のER図、API設計のシーケンス図に使えます（このドキュメントサイトでも同じ描画が使われています）。

## 位置づけ

- 基本設計書は**社内向けの実装リファレンス**です。既定の公開範囲はワークスペース内部で、ステークホルダー（viewer）には表示されません。
- 要件と直接はつながっていませんが、AI叩き台が要求・要件を参照して作られるため、内容はプロジェクトの要件に沿ったものになります。

## 次のステップ

- [タスク管理](https://pmonrails.com/docs/tasks.md) / [Claude Web・Claude Code・MCP連携](https://pmonrails.com/docs/mcp.md)

---

https://pmonrails.com/docs/basic-design