セットアップを再現できるREADMEの作り方。
README は確認済み要件からセットアップを再現できるものにします。確認済み手順と提案段階のコマンド、入手できない設定を区別してください。
作業手順をタスクに合わせましょう。
リポジトリの実際のスクリプト、前提条件、設定を使い、セットアップと初回利用を説明します。検証済みコマンドと提案手順を分け、例から秘密情報を除き、テストへの明確な道筋を示してください。
- 用意するもの
- 確認済みのプロジェクト動作とセットアップ要件。
- 得られるもの
- 検証が必要な実行可能手順を含むプロジェクト文書。
入力と結果を確認しましょう。
説明用の入力と出力 · 実際の WebAct 実行ではない学習用サンプル
入力項目サンプル個
Write a minimal README. Fictional project: Tiny Notes. Requires Node 24 and npm, has package-lock.json, scripts dev and test, no environment variables needed for local use.
完成例
# Tiny Notes A small notes application. ## Requirements Node 24 and npm. ## Local setup Install locked dependencies with `npm ci`. Start development with `npm run dev`, then open the URL printed by the development server. ## Tests Run `npm test`. ## Configuration No environment variables are required for local use. These instructions reflect the supplied project facts; no repository execution is claimed.
この入力をプロンプトに読み込み、WebAct にコピーして試してください。結果は掲載例と異なる場合があります。
判断のポイントとトラブル対処。
README では一般的に聞こえるインストールコマンドを創作してよいですか？
まずプロジェクトを確認してください。よくあるコマンドも、使っているパッケージ管理ツール、ロックファイル、ビルド手順には不適切かもしれません。
README に従ってもセットアップが失敗するのはなぜですか？
実行環境のバージョン、必須設定、実際のスクリプトを比較してください。曖昧な対処法の段落を足すのではなく、欠けた手順を再現します。
自分の資料で試しましょう。
タスクのプロンプト内の例を自分の資料に置き換えてください。必要な要件を残し、タスクを WebAct にコピーします。
タスクを調整してコピー ↑