CtrlK
BlogDocsLog inGet started
Tessl Logo

doc-comments

How to write inline comments, rustdoc, and module documentation in the Biome codebase. The audience is Biome developers reading the source, not end users. Use whenever writing or editing `//` comments, `///` item docs, or `//!` module docs — including comments added incidentally while fixing bugs or implementing features.

79

Quality

100%

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

100%Weight 40%Scale 1-3

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

An exemplar instruction skill: lean, concrete, and well-structured, with BAD/GOOD patterns, a deletion test, and a closing self-check validation loop. It assumes competence and routes external depth to one-level-deep references rather than inlining it.

DimensionReasoningScore

Conciseness

Assumes Claude's competence throughout — no explanation of what comments, Rust, or rustdoc are — and every section (Reader, Three Kinds, Deletion Test, Banned Patterns, Region Comments, Self-Check) earns its place; the Diátaxis framework is linked rather than retold.

3 / 3

Actionability

Concrete BAD/GOOD code pairs for each banned pattern, an explicit Deletion Test, and precise region-comment rules give copy-ready, executable guidance rather than abstraction; the instruction-only guidance is specific and actionable.

3 / 3

Workflow Clarity

The 'Self-Check Before Finishing' section is an explicit validation checkpoint (re-read only the comments in the diff, apply three checks, fix or delete what fails) — a clear feedback loop for the destructive act of editing/deleting comments.

3 / 3

Progressive Disclosure

Well-organized into clearly labeled sections with one-level-deep, clearly signaled references (Diátaxis, the lint-rule-development skill, and the workspace.rs exemplar); no nested-reference chains and no bundle files needed.

3 / 3

Total

12

/

12

Passed

Description

100%Weight 40%Scale 1-3

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 model description: third-person voice, concrete actions, natural trigger terms, an explicit 'Use whenever…' clause, and a clear niche scoped to the Biome codebase. It answers both what and when without padding or over-claiming.

DimensionReasoningScore

Specificity

Lists multiple concrete actions — writing inline comments, rustdoc, and module documentation — naming all three comment kinds (`//`, `///`, `//!`), matching the 'lists multiple specific concrete actions' anchor.

3 / 3

Completeness

Explicitly answers both 'what' ('How to write inline comments, rustdoc, and module documentation in the Biome codebase') and 'when' ('Use whenever writing or editing `//` comments, `///` item docs, or `//!` module docs — including comments added incidentally while fixing bugs or implementing features').

3 / 3

Trigger Term Quality

Natural terms a developer would say are well covered: 'writing or editing comments', 'rustdoc', 'item docs', 'module docs', 'fixing bugs', 'implementing features', with the syntactic markers `//`/`///`/`//!` included.

3 / 3

Distinctiveness Conflict Risk

Scoped tightly to the Biome codebase and to comment/rustdoc authoring, with distinct triggers unlikely to fire for unrelated skills; the audience boundary (developers, not end users) further sharpens the niche.

3 / 3

Total

12

/

12

Passed

Validation

93%

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

Validation15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

relative_links

Relative link issues: 4 suspicious

Warning

Total

15

/

16

Passed

Repository
biomejs/biome
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.