Skip to content
SpecifyDocs

Workflows

Generate onboarding docs

Guide new teammates through setup, their first run, code navigation, and team procedures.

Help new teammates understand the code and reach their first local run by separating repository evidence from team information that people must supply.

Prepare the sources

Choose the repository, branch, existing README, the teammate’s role, and their first goal. Keep real passwords, tokens, and personal contact details out of onboarding materials.

Project overview created from Mamma source code
Inspect source evidence and the main components in a document.

Generate and review

Ask in chat for a repository map and architecture diagram explaining entry points and dependencies. Derive install, run, and test commands from package configuration and scripts. People should supply access requests, review and deployment agreements, and the responsible contacts.

Update after code changes

Follow the instructions in a fresh environment and correct the places where you get stuck. Link the repository and branch to the existing onboarding document or architecture canvas to allow later pushes to update the linked content directly. Check commands and paths after updates, and have owners maintain team procedures such as access requests, reviews, and deployment agreements separately.

Example chat request

Create onboarding documentation for a backend developer joining this repository.
Include a project overview, repository map and architecture, and install, run, and test steps.
Cite source files for commands. Leave questions for access requests and team procedures not established by code.
Ask questions in chat while reviewing the diagram when the structure is unclear. If changes are needed, record the agreed work in an improvement document for the coding agent to read over MCP. Record the environment and checked result alongside commands you actually ran.

GitHub · MCP