codebase-onboarding – Marketing & SEO skill for AI agents
Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors. Fast fact-gathering and repeatable onboarding outputs. Use when onboarding a new engineer, writing architecture-overview docs for a new project, or producing tech-lead briefings for unfamiliar repos.
Install the codebase-onboarding skill with one command
Pick the tool you use, copy the command and paste it in your terminal. The skill lands in that tool's skills folder and is ready in your next session.
Claude Code
mkdir -p ~/.claude/skills && curl -fsSL https://skill.dn1nguoi.com/z/codebase-onboarding-93c0f.tgz | tar xz -C ~/.claude/skills
Call it in Claude Code: /codebase-onboarding – then describe the task you want done.
Codex
mkdir -p ~/.codex/skills && curl -fsSL https://skill.dn1nguoi.com/z/codebase-onboarding-93c0f.tgz | tar xz -C ~/.codex/skills
Call it in Codex: $codebase-onboarding – then describe the task you want done.
Hermes Agent
mkdir -p ~/.hermes/skills && curl -fsSL https://skill.dn1nguoi.com/z/codebase-onboarding-93c0f.tgz | tar xz -C ~/.hermes/skills
Call it in Hermes Agent: /codebase-onboarding – then describe the task you want done.
DeepSeek
mkdir -p ~/.deepcode/skills && curl -fsSL https://skill.dn1nguoi.com/z/codebase-onboarding-93c0f.tgz | tar xz -C ~/.deepcode/skills
Call it in DeepSeek: /codebase-onboarding – then describe the task you want done.
SKILL.md content
Codebase Onboarding
Tier: POWERFUL
Category: Engineering
Domain: Documentation / Developer Experience
---
Overview
Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors. This skill is optimized for fast fact-gathering and repeatable onboarding outputs.
Core Capabilities
- Architecture and stack discovery from repository signals
- Key file and config inventory for new contributors
- Local setup and common-task guidance generation
- Audience-aware documentation framing
- Debugging and contribution checklist scaffolding
---
When to Use
- Onboarding a new team member or contractor
- Rebuilding stale project docs after large refactors
- Preparing internal handoff documentation
- Creating a standardized onboarding packet for services
---
Quick Start
# 1) Gather codebase facts
python3 scripts/codebase_analyzer.py /path/to/repo
# 2) Export machine-readable output
python3 scripts/codebase_analyzer.py /path/to/repo --json
# 3) Use the template to draft onboarding docs
# See references/onboarding-template.md---
Recommended Workflow
1. Run scripts/codebase_analyzer.py against the target repository.
2. Capture key signals: file counts, detected languages, config files, top-level structure.
3. Fill the onboarding template in references/onboarding-template.md.
4. Tailor output depth by audience:
- Junior: setup + guardrails
- Senior: architecture + operational concerns
- Contractor: scoped ownership + integration boundaries
---
Onboarding Document Template
Detailed template and section examples live in:
references/onboarding-template.mdreferences/output-format-templates.md
---
Common Pitfalls
- Writing docs without validating setup commands on a clean environment
- Mixing architecture deep-dives into contractor-oriented docs
- Omitting troubleshooting and verification steps
- Letting onboarding docs drift from current repo state
Best Practices
1. Keep setup instructions executable and time-bounded.
2. Document the "why" for key architectural decisions.
3. Update docs in the same PR as behavior changes.
4. Treat onboarding docs as living operational assets, not one-time deliverables.
Related skills
- marketing-psychology – When the user wants to apply psychological principles, mental models, or behavioral…
- cold-email – When the user wants to write, improve, or build a sequence of B2B cold outreach emails…
- commercial-forecaster – Use when building a quarterly bookings forecast, ARR projection, pipeline forecast, NRR…
- commercial-skills – Use when reviewing, approving, or designing commercial motion — pricing models, deal…
- competitive-intel – Systematic competitor tracking that feeds CMO positioning, CRO battlecards, and CPO…
- paywalls – When the user wants to create or optimize in-app paywalls, upgrade screens, upsell…
- competitive-teardown – Analyzes competitor products and companies by synthesizing data from pricing pages, app…
- competitor-alternatives – When the user wants to create competitor comparison or alternative pages for SEO and…