DEV-001 critical Onboarding Documentation
Onboarding checklist documented
New developers need a clear path to follow. A checklist format provides progress tracking and ensures nothing is missed.
Question to ask
"How long until a new hire ships their first PR?"
Pass criteria
- ✓ Documented onboarding guide exists
- ✓ Actionable checklist format
- ✓ Updated within 6 months or after last hire
- ✓ Covers access, setup, first tasks, who to ask
Fail criteria
- ✗ No onboarding doc
- ✗ Outdated or broken doc
- ✗ Prose-only with no clear steps
- ✗ Missing critical sections
Verification guide
Severity: Critical
New developers need a clear path to follow. A checklist format is better than prose because it provides progress tracking and ensures nothing is missed.
Check automatically:
# Look for onboarding documentation
find . -maxdepth 4 -type f \( -name "*onboard*" -o -name "*new-dev*" -o -name "*getting-started*" -o -name "*setup*" \) -name "*.md" 2>/dev/null | grep -v node_modules
# Search for onboarding content in docs
grep -riE "onboarding|new (developer|engineer|hire)|getting started|first day" docs/ README.md CONTRIBUTING.md --include="*.md" 2>/dev/null
Ask user:
- "Where does a new dev start?" (Notion, README, wiki, onboarding doc)
- "Is it a checklist they can work through, or just prose?"
- "When was it last updated? By whom?"
- "Has a recent hire validated it works?"
Pass criteria:
- Documented onboarding guide exists (in repo or linked)
- Actionable checklist format (not just narrative)
- Updated within last 6 months OR after most recent hire
- Covers: access, local setup, first tasks, who to ask
Fail criteria:
- No onboarding doc ("we just pair with someone")
- Doc exists but outdated (references deprecated tools, wrong URLs)
- Prose-only with no clear steps
- Missing critical sections (access, setup, or context)
Evidence to capture:
- Location of onboarding doc
- Format (checklist vs prose)
- Last updated date
- Sections covered