Agent skill
onboard
Use when a new developer needs to understand the project, or the user asks for an onboarding or setup guide.
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/other/other/onboard-huzaifa525-claude-code-optimize
SKILL.md
Generate a complete onboarding guide for this project.
Analyze
-
Project basics
- Read package.json / pyproject.toml / Cargo.toml / go.mod
- Identify language, framework, database, key dependencies
- Read README if it exists
-
Project structure
- Scan top-level directories
- Identify source, test, config, build, and doc directories
- Map the architecture
-
Entry points
- Find main/index files
- Find route definitions
- Find configuration files
-
Development workflow
- Read scripts in package.json
- Check for Makefile, docker-compose, CI config
- Identify how to run, test, build, deploy
-
Code conventions
- Read linter configs (.eslintrc, .prettierrc, ruff.toml, etc.)
- Check existing CLAUDE.md or .editorconfig
- Sample 3-4 files to identify patterns
-
Git workflow
- Check branch naming from recent branches
- Read git log for commit message style
- Check for PR templates (.github/pull_request_template.md)
Output
# Onboarding Guide: [Project Name]
## Quick Start
1. Clone: `git clone [url]`
2. Install: `[install command]`
3. Setup: `[env setup, db setup]`
4. Run: `[dev command]`
5. Test: `[test command]`
## Architecture
[High-level architecture diagram/description]
## Project Structure
[Directory map with purpose of each]
## Key Files
[Entry points and important files]
## Tech Stack
| Category | Technology |
|----------|-----------|
| Language | [X] |
| Framework | [X] |
| Database | [X] |
| Testing | [X] |
## Development Workflow
[How to create branches, commit, PR]
## Code Conventions
[Naming, structure, patterns used]
## Common Tasks
- Add a new API endpoint: [steps]
- Add a new component: [steps]
- Add a new test: [steps]
- Run specific tests: [command]
## Environment Variables
[Required env vars and what they do]
## Useful Commands
| Command | What It Does |
|---------|-------------|
| [cmd] | [description] |
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
majiayu000/claude-skill-registry
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
majiayu000/claude-skill-registry
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
majiayu000/claude-skill-registry
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?