🚀 新規事業
create-readme-spec
最終更新 2026年05月09日 / 40_新規事業/SCALE_Build/カタログ/プロンプト集/create-readme-spec.md
README + 設計書を作成
いつ使う?
新システムを作ったら必ず作るドキュメント
コピペ用 指示文
このシステムの README と設計書を作成してください。
【README に含めるもの】
- システム概要(1-2行)
- 技術スタック
- セットアップ手順
- デプロイ手順
- 環境変数一覧
- ディレクトリ構造
- よくあるトラブル
【設計書(_SCALE_xxx_設計書.md)に含めるもの】
- 目的・背景
- 機能一覧
- データモデル(テーブル定義)
- API仕様
- 画面遷移図
- 外部連携
- 拡張ポイント
【保存先】
- README: プロジェクトルート
- 設計書: ~/Obsidian/SCALE-Brain/31_システム開発部/
タグ
#ドキュメント / #運用