AI活用

執筆・検証: MD Converter編集部

ChatGPTで設計書を作るMarkdownプロンプト集｜基本設計・API仕様書

ChatGPTやClaudeで基本設計書、詳細設計書、API仕様書、テスト仕様書をMarkdown出力するプロンプト例と、PDF化前の確認方法を紹介します。

ChatGPTで設計書を作るときは構成まで指定する

ChatGPTやClaudeへ「設計書を作って」とだけ依頼すると、一般論が多い文章や、見出し階層が細かすぎるMarkdownになりがちです。実務で使える設計書へ近づけるには、文書の目的、読者、確定情報と未確定情報の扱い、見出し階層、表の列数、出力形式までプロンプトで指定します。

AIは下書きと構造整理には便利ですが、存在しない仕様や根拠のない数値を補う場合があります。出力後は担当者が事実、要件、セキュリティ、固有名詞、参照資料を確認してください。

基本設計書を作るプロンプト

次のテンプレートへ案件情報を追加して使えます。

あなたは業務システムの設計担当者です。以下の情報から、日本の社内レビューで使える基本設計書をMarkdownで作成してください。

目的: [システムの目的]
読者: PM、開発者、運用担当者
前提: [確定している要件]
対象外: [今回扱わない範囲]

出力条件:
- H1は文書タイトルだけにする
- 主要章はH2、補足項目はH3までにする
- 「以下に作成します」などの会話文は書かない
- 不明な内容を推測せず「要確認」と記載する
- 表は最大4列とし、長文は表の外へ出す
- 絵文字を使わない
- 出力はMarkdown本文だけにする

構成:
# システム基本設計書
## 文書情報
## 概要
## 背景と目的
## 対象範囲
## システム構成
## 機能一覧
## データ概要
## 外部インターフェース
## 非機能要件
## セキュリティ
## 運用・監視
## 制約事項
## 未決事項

「要確認」を明示させることで、AIの推測と確定仕様を混ぜにくくなります。出力後は未決事項を担当者、期限、判断材料へ分解するとレビューしやすくなります。

詳細設計書を作るプロンプト

詳細設計では実装可能な粒度と、上位設計との対応を指定します。

次の基本設計と要件から詳細設計書をMarkdownで作成してください。

必須項目:
- 機能IDと機能名
- 入力、処理、出力
- 正常系と異常系
- バリデーション
- 権限チェック
- ログと監視
- 関連する要件ID

コードを推測で実装せず、疑問点は「要確認事項」にまとめてください。
各機能はH2、機能内の項目はH3で記載してください。

既存の命名規則、エラーコード体系、ログレベルがある場合はプロンプトへ渡します。機密値や本番の認証情報は入力しないでください。

API仕様書を作るプロンプト

次のAPI要件を、開発者が実装・レビューできるMarkdown仕様書にしてください。

APIごとに以下を記載:
- エンドポイントとHTTPメソッド
- 認証・認可
- パス、クエリ、ヘッダー、リクエストボディ
- 成功レスポンス例
- エラーレスポンスと条件
- 冪等性、タイムアウト、レート制限
- 監査ログ

JSON例はコードブロックにし、表はパラメータ一覧など短い比較だけに使ってください。
不明な型、桁数、必須条件を補完せず「要確認」としてください。

長いJSONを大量に載せるとPDFでページが崩れます。代表例だけを本文へ置き、完全なスキーマは別ファイルへ分ける方法も有効です。

テスト仕様書を作るプロンプト

以下の要件と設計からテスト観点とテストケース案をMarkdownで作成してください。

- 正常系、境界値、異常系、権限、同時実行を分ける
- ケースごとにID、前提条件、操作、期待結果、関連要件IDを書く
- 推測した期待結果は作らず、不明点を別章へ出す
- 1つのセルへ長文を詰めず、詳細手順はケースの下へ書く
- 重複ケースをまとめ、網羅性の根拠を説明する

AIが作ったケース数が多いことと品質は同じではありません。要件との対応、リスク、実行可能性を人が確認します。

出力されたMarkdownをレビューする

次の順で確認すると効率的です。

  1. 要件にない機能が追加されていないか
  2. 未確定事項が断定されていないか
  3. H1が1つ、本文がH2・H3で整理されているか
  4. 表がA4の幅へ収まるか
  5. 長いコード、URL、JSONが整理されているか
  6. 重複する概要やまとめがないか
  7. 機密情報や個人情報が含まれていないか

AIへ再修正を依頼する場合は「もっと詳しく」ではなく、「機能一覧を4列以内の表にする」「未確定値を要確認へ移す」のように変更箇所を限定します。

Markdownから設計書PDFへ仕上げる

回答を.mdとして保存し、印刷プレビューを確認できるMarkdown変換器へ読み込みます。表紙、目次、余白、ページ番号を設定し、表紙へタイトル、組織、日付、版番号を入力します。目次の階層とページ番号が本文の構成に合っているか、保存したPDFまで確認してください。

表、コード、図の前後で不自然に切れる場合は、印刷用CSSや変換ソフトの改ページ設定を調整します。画像は原稿側で適切な大きさにし、必要に応じてCSSで配置を指定します。最後に保存したPDFを開き、ページ数、目次、文字化け、リンク、最終ページまで確認してください。

よくある質問

ChatGPTの回答をそのまま設計書として提出できますか？

推奨できません。AIは文書構造を整えられますが、要件の正しさや組織固有のルールを保証しません。下書きとして使い、設計責任者がレビューしてください。

Claudeでも同じプロンプトを使えますか？

使えます。モデルによって表現は変わるため、見出し階層、推測禁止、Markdownのみという条件を毎回明示します。

長い設計書は一度に作るべきですか？

章構成を先に作り、確定した入力資料を章ごとに渡す方が確認しやすくなります。最後に用語、文体、要件IDを統一してください。

関連記事

PDFで仕上がりを確認する

AIで作ったMarkdown設計書をPDFにする