AI Blocks › Build and ship software
New teammate guide writer
Point it at a codebase. Get an onboarding guide for new engineers, leads or contractors.
New teammate guide writer is a free AI skill for the job "Build and ship software". Give the instructions to an AI assistant that supports the required files and tools, then review its output.
Free · No account · MIT licence · Made by Alireza Rezvani · Level: beginner
Made by Alireza Rezvani. See the original on GitHub; we copied it as it is, with its licence.
What it does
A written guide that gets a new engineer, tech lead or contractor working in your codebase without a week of questions. You point it at a repository and it writes the guide from what the code shows. A Python script first scans the project: file counts, languages, config files and folder layout. Those facts go into a template covering the stack, key files, local setup, common tasks, debugging tips and a contribution checklist. The depth changes by reader. Juniors get setup and guardrails, seniors get architecture and operations, and contractors get their scope and the edges where they connect to other systems. Python must be installed.
You give it
- The path to your repository
- Who the guide is for
- Any setup quirks you know (optional)
- Python on your computer
You get
- A scan of languages, files and structure
- A guide filled in from the template
- Setup and common task steps
- A debugging and contribution checklist
Use it when
- A contractor starts Monday and the old docs are stale.
- A big refactor made your README wrong.
- You want the same onboarding pack for every service.
- A new tech lead needs the architecture fast.
How to use it
- Add it to your AI once: download it and add the folder to Claude, ChatGPT or Codex as a skill.
- Ask for the job in your own words. Your AI opens the skill when it fits.
- It works best when your AI can run code and read your project files.