doc-comments

Use this skill whenever writing or editing Rust `//`, `///`, or `//!` comments in Biome, including comments added incidentally and end-user rustdoc inside lint/assist declarations. For lint/assist rustdoc, also load lint-rule-development for content requirements. Do not use for formatter handling of comments in user code.

Quality

93%

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

Quality

Content

100%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 content is an exemplary instruction skill: concise, concrete with BAD/GOOD code, a real exemplar pointer, and a validation self-check with a fix-or-delete loop. Structure is clean with shallow, well-signaled references and no unnecessary background.

Dimension	Reasoning	Score
Conciseness	The body is lean and assumes Rust competence throughout: it defines only the repository-specific reader model and rules, uses short tables and minimal code blocks, and never explains general concepts Claude already knows. Every section earns its place.	5 / 5
Actionability	Provides concrete, copy-paste-style guidance: a kind/job/contains table, BAD/GOOD rust examples for each banned pattern, a paired `// #region`/`// #endregion` convention, and a pointer to a real exemplar file with the specific properties to imitate.	5 / 5
Workflow Clarity	The 'Self-Check Before Finishing' section is an explicit 3-step validation checklist with a fix-or-delete feedback loop, and the 'Deletion Test' gives a reusable decision procedure; the editing workflow is clearly sequenced with recovery guidance.	5 / 5
Progressive Disclosure	The skill is a self-contained, well-sectioned overview with only one-level-deep, clearly signaled references (the workspace.rs exemplar, Diátaxis, and the sibling lint-rule-development skill); no bundle files are present or needed, and references are not nested.	5 / 5
	Total	20 / 20 Passed

Description

86%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 specific, trigger-rich, and clearly scoped to a distinct niche with explicit positive and negative triggers and a sibling-skill hand-off. It is slightly verbose but remains clear and concrete.

Dimension	Reasoning	Score
Specificity	Names the domain (Rust `//`, `///`, `//!` comments in Biome) and lists several concrete actions (writing/editing comments, incidental comments, end-user rustdoc in lint/assist), but the actions are framed as situations rather than a fully enumerated action set, leaving minor coverage gaps.	4 / 5
Completeness	Explicitly answers what ('writing or editing Rust `//`, `///`, or `//!` comments in Biome, including comments added incidentally and end-user rustdoc inside lint/assist declarations') and when ('Use this skill whenever writing or editing... Do not use for formatter handling'), with concrete trigger phrases and a clear scope hand-off.	5 / 5
Trigger Term Quality	Includes natural triggers like 'writing or editing Rust comments', 'incidental comments', and 'lint/assist declarations', plus an explicit negative trigger ('Do not use for formatter handling'); a few common synonyms a user might say (e.g. 'doc comment', 'rustdoc') are present but coverage is not exhaustive.	4 / 5
Distinctiveness Conflict Risk	A clearly defined niche (Rust comment hygiene in the Biome repo) with an explicit negative trigger and a directed hand-off to lint-rule-development for rustdoc content, minimizing conflict with sibling skills.	5 / 5
	Total	18 / 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
relative_links	Relative link issues: 4 suspicious	Warning

	Total	15 / 16 Passed

Repository: biomejs/biome
Path: .claude/skills/doc-comments/SKILL.md
Commit: 7d54688

Reviewed: 1 day 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.