本文へスキップ
SpecifyDocs

活用ガイド

オンボーディングドキュメントの生成

新しいメンバーの初回起動とコード理解を支える、セットアップ・起動・探索の手順とチームの進め方を整理します。

新しいメンバーがコード構造を理解して初回起動まで進めるよう、リポジトリで確認できる案内とチームが補う情報を分けます。

資料を準備する

リポジトリ、ブランチ、既存README、メンバーの役割と最初の目標を決めます。実際のパスワード、トークン、個人の連絡先は資料に含めません。

Mammaの実際のコードから作成したプロジェクト概要
文書でコードの根拠と主要な構成要素を確認します。

生成してレビューする

主要ディレクトリ、入口、構成要素の依存関係を説明する文書とアーキテクチャ図をチャットで依頼します。インストール・起動・テストのコマンドは設定やスクリプトを根拠にします。権限申請、レビュー・デプロイの合意、相談先は人が補います。

コード変更後に更新する

新しい環境で案内どおりに実行し、行き詰まった箇所を修正します。既存のオンボーディング文書や構造のキャンバスにリポジトリとブランチを接続すると、以後のpushに基づいて接続先を直接更新できます。更新後はコマンドとパスを確認し、権限申請やレビュー・デプロイの合意など、チームの手順は担当者が別途管理します。

チャットへの依頼例

このリポジトリに初参加するバックエンド開発者向けのオンボーディング文書を作って。
概要、リポジトリの地図とアーキテクチャ、インストール・起動・テストの順序を含めて。
コマンドの根拠ファイルを示し、コードで確認できない権限申請やチームの手順は質問として残して。
構造が分からなければ、図を見ながらチャットで質問します。改善が必要なら合意した内容を改善ドキュメントに残し、コーディングエージェントにMCPで読ませられます。実際に実行したコマンドには、環境と確認した結果も記録してください。

GitHub · MCP