Agent skill · writing content · aj-geddes
developer-onboarding
Create comprehensive developer onboarding documentation including setup guides, README files, contributing guidelines, and getting started tutorials. Use when onboarding new developers or creating setup documentation.
Why this skill is useful
Codifies best practices for developer onboarding documentation that the AI could infer but now doesn't have to guess.
What it needs
About 1k tokens when loaded. Last updated 2026-03-04. 307 stars on the source repository.
What this skill does
Developer Onboarding Table of Contents Overview When to Use Quick Start Reference Guides Best Practices Overview Create comprehensive onboarding documentation that helps new developers quickly set up their development environment, understand the codebase, and start contributing effectively. When to Use New developer onboarding README file creation Contributing guidelines Development environment setup Architecture overview docs Code style guides Git workflow documentation Testing guidelines Deployment procedures Quick Start Minimal working example: Reference Guides Detailed implementations in the references/ directory: Guide Contents --- --- Clone the Repository Clone the Repository, Install Dependencies Set Up Environment Variables Set Up Environment Variables Database Setup Database Setup, Verify Installation Project Structure Project Structure Available Scripts Available Scripts Code Style Code Style Git Workflow Git Workflow Running Tests Running Tests Writing Tests Writing Tests Best Practices ✅ DO Start with a clear, concise project description Include badges for build status, coverage, etc. Provide a quick start section Document all prerequisites clearly Include troubleshooting section Keep README up-to-date Use code examples liberally Add architecture diagrams Document environment variables Include contribution guidelines Specify code style requirements Document testing procedures ❌ DON'T Assume prior knowledge Skip prerequisite documentation Forget to update after major changes Use overly technical jargon Skip example code Ignore Windows/Mac/Linux differences Forget to document scripts
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aj-geddes/developer-onboarding