Onboarding Doc Skill: Onboarding Docs That Are Actually True
Writes a CONTRIBUTING doc from the repo's real scripts and structure. Onboarding docs go wrong when they describe process the team doesn't actually follow.
Full Prompt
An installable onboarding-doc skill. Reads package scripts, the repo layout, and existing docs, then writes a concise CONTRIBUTING-style doc.
What It Does
- Reads real scripts — no invented commands
- Explicit deps — Docker, databases, runtime versions
- Project layout map — one line per folder, what lives there
- Refuses to invent process — no fake review or branch rules
Install in 30 Seconds
Pick your tool above and download:
- Claude Code:
~/.claude/skills/onboarding-doc/SKILL.md - OpenAI Codex CLI: append to
AGENTS.md - Cursor: append to
.cursorrules
Same content, three install paths. Reload and ask for the audit on your next change.
Why This Skill Earns Its Keep
Onboarding docs go wrong when they describe process the team doesn't actually follow. This skill enforces evidence: if it can't point to the script, workflow file, or CODEOWNERS entry, it leaves the section out. Boring is better than wrong.
Install once, run before every push.