CtrlK
BlogDocsLog inGet started
Tessl Logo

codebase-onboarding

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.

65

Quality

78%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

The risk profile of this skill

Fix and improve this skill with Tessl

tessl review fix ./engineering/skills/codebase-onboarding/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

78%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

A well-structured, actionable skill body with executable commands and properly split references into real bundle files. The main improvement would be de-duplicating the Overview with the description and adding an explicit validation checkpoint to the workflow.

Suggestions

Remove or trim the Overview paragraph that repeats the frontmatter description verbatim to improve conciseness.

Add an explicit verification checkpoint in the Recommended Workflow (e.g. confirm the analyzer output is non-empty before drafting docs) rather than only mentioning validation in Common Pitfalls.

Make the audience-tailoring step more actionable with a concrete example of how output depth differs for junior vs senior vs contractor audiences.

DimensionReasoningScore

Conciseness

Largely efficient bullet-and-command structure with no padding of concepts Claude already knows; the only blemish is the Overview paragraph duplicating the frontmatter description nearly verbatim.

4 / 5

Actionability

Provides copy-paste-ready commands ('python3 scripts/codebase_analyzer.py /path/to/repo' and '--json') plus a real script and template, with minor gaps such as the audience-tailoring guidance staying high-level.

4 / 5

Workflow Clarity

The Recommended Workflow gives a clear numbered sequence (run analyzer, capture signals, fill template, tailor by audience); validation is acknowledged via Common Pitfalls and the template's verify checklist rather than an embedded checkpoint, a minor gap for a non-destructive task.

4 / 5

Progressive Disclosure

The body is a concise overview with well-signaled, one-level-deep references to real bundle files — scripts/codebase_analyzer.py, references/onboarding-template.md, and references/output-format-templates.md — all of which exist.

5 / 5

Total

17

/

20

Passed

Description

78%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

A strong description that clearly answers both what the skill does and when to use it, with natural trigger phrases for onboarding and tech-lead briefings. It could list more specific analysis actions to push specificity higher.

DimensionReasoningScore

Specificity

Names the domain and two concrete actions — 'Analyze a codebase' and 'generate onboarding documentation' — but does not enumerate the breadth of what the analysis covers, so coverage is not comprehensive.

3 / 5

Completeness

Explicitly states both what ('Analyze a codebase and generate onboarding documentation...') and when ('Use when onboarding a new engineer, writing architecture-overview docs...') with concrete trigger phrases.

5 / 5

Trigger Term Quality

Includes natural phrases a user would say — 'onboarding a new engineer', 'writing architecture-overview docs', 'tech-lead briefings for unfamiliar repos' — though a few synonyms (e.g. 'developer docs', 'handoff') are missing.

4 / 5

Distinctiveness Conflict Risk

The codebase-onboarding niche is mostly distinct with clear triggers, but carries minor overlap risk with general code-analysis or documentation skills.

4 / 5

Total

16

/

20

Passed

Validation

100%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository
alirezarezvani/claude-skills
Reviewed

Table of Contents

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.