オンボーディング文書の生成：新しい開発者を最初の実行まで案内

開発者向けオンボーディング文書の目的は、新しいメンバーがプロジェクトを実行し、最初の作業場所を見つけることです。リポジトリで確認できる事実と、人が説明する背景を分けましょう。

最初の実行に必要な構成

• プロジェクトが解決する問題と利用者。
• 必要なランタイム、ツール、権限の申請先。
• インストール、環境設定、実行、テストのコマンド。
• 主要フォルダ、入口、リクエスト処理の流れ。
• 最初の作業例とレビュー・デプロイ担当。

環境変数は名前、用途、取得方法を説明し、実際の秘密値は掲載しないでください。

自動生成と人による補足

設定ファイル、スクリプト、ソース構造は実行ガイドの根拠になります。一方、設計理由、権限の承認担当、障害対応の習慣はコードにない場合があります。推測で埋めず、確認事項として残します。

Specifyで始める手順

1. GitHubリポジトリを文書プロジェクトに接続します。
2. 必要な文書を選んで生成を開始します。
3. 現在の開発環境でコマンドとパスを検証します。
4. 権限申請やチームの判断背景を補足します。
5. 以後のコード変更に合わせ、関連文書と修正案を確認します。

GitHub連携ガイドでは接続範囲と反映方針を説明しています。処理時間や下書きの充実度は利用できる資料によって異なります。

初めて読む人が検証する

既存メンバーには当然の設定が、新しい人には抜けていることがあります。文書だけでインストール、実行、テストを試してもらい、止まった箇所や追加質問を記録します。文書の生成完了だけでオンボーディング成功とは判断しません。

維持するチェックリスト

ランタイム、実行コマンド、環境変数名、フォルダ、デプロイ手順が変わったら再確認します。APIを扱う場合はAPI文書更新チェックリストも活用してください。

機能紹介を確認し、ワークスペースを開始できます。