CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

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

82%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Passed

No findings from the security scan

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, efficient skill body: a runnable analyzer script, a clear four-step workflow, and clean offloading of the onboarding templates to real, well-signaled reference files. The remaining gaps are mild — the Overview duplicates the description and the documentation-side guidance leans on principles rather than concrete checks or examples.

DimensionReasoningScore

Conciseness

The body is lean and assumes competence — no space is spent explaining what onboarding or codebases are, and the Quick Start is three commented commands. Minor trim opportunities keep it off anchor 5: the Overview paragraph repeats the frontmatter description verbatim, and abstract bullets like "Audience-aware documentation framing" earn little. It is clearly above anchor 3, which would require noticeably unnecessary explanation.

4 / 5

Actionability

Quick Start and Recommended Workflow give concrete, runnable commands ("python3 scripts/codebase_analyzer.py /path/to/repo", "--json") with real backing files, and step 4 gives per-audience output depth. Falls short of anchor 5 because the doc-authoring half of the workflow stays abstract — the "Common Pitfalls" and "Best Practices" sections are aphorisms rather than executable checks, and no sample output snippet is shown inline.

4 / 5

Workflow Clarity

The four-step Recommended Workflow is a clear, concrete sequence (run analyzer → capture signals → fill template → tailor by audience) with the audience branching made explicit. This is a low-risk, non-destructive task so the strict validation cap does not apply; it misses anchor 5 only because verification appears solely as a pitfall ("validating setup commands on a clean environment") rather than as an explicit validate-then-publish checkpoint in the workflow itself.

4 / 5

Progressive Disclosure

The SKILL.md is a genuine overview: it stays short, uses clean section headers, and pushes the bulk of detail to two clearly signaled one-level-deep references ("references/onboarding-template.md", "references/output-format-templates.md"), both of which exist in the bundle and are surfaced both in Quick Start and a dedicated template section. No nesting, no buried references, no content that belongs in a separate file inlined — matching the anchor-5 example structure.

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 with explicit and concrete what/when coverage in third-person voice and natural trigger phrases. Its main weakness is that the capability list stays high-level ("analyze a codebase") rather than enumerating the specific outputs the skill produces.

Suggestions

Replace the property statements "Fast fact-gathering and repeatable onboarding outputs" with 1-2 concrete actions, e.g., "discover stack and architecture from repo signals, inventory key files and configs, and generate setup and contribution guidance".

Add common synonym triggers users might say, such as "developer onboarding", "getting-started docs", or "handoff documentation".

DimensionReasoningScore

Specificity

"Analyze a codebase and generate onboarding documentation" names the domain and two concrete actions, but the action list is not comprehensive — the actual capabilities (stack discovery, setup guidance, checklists) surfaced in the body are absent, and "Fast fact-gathering and repeatable onboarding outputs" describes properties rather than actions. It sits above anchor 2 (which would offer only a generic action with no domain) but does not list the several specific actions anchor 4 requires.

3 / 5

Completeness

Both halves are explicit: the "what" ("Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors") and a concrete "when" clause ("Use when onboarding a new engineer, writing architecture-overview docs for a new project, or producing tech-lead briefings for unfamiliar repos") with three concrete trigger scenarios — matching the anchor-5 good example pattern. It is not score 4 territory because the "when" is fully explicit and specific, not merely present.

5 / 5

Trigger Term Quality

Natural phrases users would say are present: "onboarding a new engineer", "architecture-overview docs", "tech-lead briefings", "unfamiliar repos", "contractors". Coverage is good but a few natural variants are missing (e.g., "developer onboarding", "getting-started docs", "handoff docs"), keeping it below anchor 5's comprehensive synonym coverage.

4 / 5

Distinctiveness Conflict Risk

The onboarding-documentation niche with named audiences (engineers, tech leads, contractors) is mostly distinct from other skill domains, and triggers like "onboarding a new engineer" are unlikely to fire a wrong skill. Minor overlap risk remains with generic documentation-writing or code-explainer skills, so it does not reach anchor 5's clear-niche bar.

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.

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository

alirezarezvani/claude-skills

Path

engineering/skills/codebase-onboarding/SKILL.md

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.