一覧へ戻る
ドキュメント作成 おすすめ 難易度: 初級

READMEを実務向けに整備する

セットアップ、開発フロー、運用前提まで含めた README を整えたい時に便利。

ワンタップ操作

詳細を確認してからコピーしたい時のために、全文コピーとお気に入り保存をここから使えます。

Prompt Body

全文

以下のプロジェクト情報をもとに、実務で役立つ README を作成してください。

必ず含める章:
- プロジェクト概要
- 技術スタック
- セットアップ手順
- 開発サーバ起動方法
- ビルド / テスト方法
- ディレクトリ構成
- よくあるハマりどころ
- デプロイ方法

条件:
- 新規参加者が15分で動かせることを目標にする
- 曖昧な情報は TODO ではなく確認事項として分ける
- コピペ可能なコマンドを優先する

Use Cases

どんな場面で使うか

  • READMEの再整備
  • 新規メンバー向け導線整備
  • OSS公開前

Recommended For

おすすめ対象

実務向け汎用性高チーム開発

Example

入力例

情報: Astro + TypeScript + Tailwind の静的サイト。pnpm 使用。環境変数は不要。

Expected Output

期待する出力例

コピペ可能なコマンド付きで、参加者が迷わない README 草案が返る。

Related

関連プロンプト

一覧へ
詳細を見る
詳細を見る
詳細を見る