Name: codebase-onboarding
Rating: 60.8 (1 reviews)
Author: alirezarezvani

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.

Quality

71%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./.gemini/skills/codebase-onboarding/SKILL.md

The canonical home for this skill is codebase-onboarding in alirezarezvani/claude-skills

Quality

Content

65%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.

The body is concise and supplies concrete executable commands, and it is cleanly sectioned. Its weaknesses are a workflow with no validation/verification checkpoint and, more seriously, references to scripts and template files that are not present in the bundle, which breaks progressive disclosure navigation.

Suggestions

Add an explicit verification step to the Recommended Workflow (e.g., confirm the analyzer ran against a clean checkout and cross-check key signals before drafting docs), so the sequence has a real checkpoint.

Either include the referenced bundle files (scripts/codebase_analyzer.py, references/onboarding-template.md, references/output-format-templates.md) or remove the dangling references so navigation resolves.

Replace the abstract audience labels ('Junior: setup + guardrails') with concrete, actionable tailoring instructions so the audience step is executable rather than descriptive.

Dimension	Reasoning	Score
Conciseness	The body is lean — short overview, bulleted capabilities, a Quick Start with commands, and a numbered workflow — with no padding of concepts Claude already knows. Not a 5 because the 'When to Use' list overlaps the description's 'Use when...' clause; not a 3 because it is efficient rather than carrying unnecessary explanation.	4 / 5
Actionability	Quick Start gives concrete, copy-pasteable commands ('python3 scripts/codebase_analyzer.py /path/to/repo', '--json'). Not a 5 because the audience-tailoring guidance ('Junior: setup + guardrails') is abstract rather than executable; not a 3 because real executable commands are present rather than pseudocode.	4 / 5
Workflow Clarity	The Recommended Workflow is a clear four-step numbered sequence, but it lacks any validation or verification checkpoint ('Capture key signals' is vague, no verify step). Not a 4 because no explicit checkpoints are present; not a 2 because the sequence itself is clear and well-defined rather than rough with many gaps.	3 / 5
Progressive Disclosure	The body is well-sectioned and signals one-level-deep references ('references/onboarding-template.md', 'references/output-format-templates.md'), but those referenced scripts and reference files do not exist in the bundle, so navigation is broken. Not a 4 because the references are dangling; not a 2 because the section structure is clear rather than minimal with inlined content that belongs in separate files.	3 / 5
	Total	14 / 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.

The description is strong: it clearly states what the skill does and gives explicit, natural trigger phrases for when to use it. The main weakness is specificity, which stays at the midpoint because it names the domain and two actions without listing several granular capabilities.

Dimension	Reasoning	Score
Specificity	Names the domain plus two concrete actions ('Analyze a codebase and generate onboarding documentation', 'Fast fact-gathering and repeatable onboarding outputs'), but does not enumerate several specific sub-actions. It is above a 2 (actions are concrete, not minimal/generic) but below a 4 (no list of several specific actions).	3 / 5
Completeness	Explicitly answers 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. Matches the anchor for clearly and explicitly answering both; the 'when' is specific rather than merely present.	5 / 5
Trigger Term Quality	Includes natural phrases users would say — 'onboarding a new engineer', 'writing architecture-overview docs', 'tech-lead briefings for unfamiliar repos' — giving good keyword coverage. Not a 5 because common synonyms like 'ramp up' or 'handoff docs' are absent; not a 3 because the terms are genuinely natural rather than vague jargon.	4 / 5
Distinctiveness Conflict Risk	'Codebase onboarding documentation' is a clear niche with distinct triggers, only minor overlap risk with general documentation skills. Not a 5 because it could still overlap with broad doc-generation skills; not a 3 because the niche and triggers are clearly specific.	4 / 5
	Total	16 / 20 Passed

Validation

93%

Warnings & errors only

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

Validation — 15 / 16 Passed

Validation for skill structure

Criteria	Description	Result
referenced_paths_exist	Referenced path issues: 7 missing	Warning

	Total	15 / 16 Passed

Repository: alirezarezvani/claude-skills
Path: .gemini/skills/codebase-onboarding/SKILL.md
Commit: 19392f7

Reviewed: ~3 hours ago

Table of Contents

Discovery Implementation Validation

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.