documenting-rust-code

Rust documentation practices for HASH codebase. Use when writing doc comments, documenting functions/types/traits/modules, creating error sections, using intra-doc links, or following rustdoc conventions.

Quality

100%

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%

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

A well-organized, token-efficient reference of concrete rustdoc patterns with executable examples, a verification checkpoint, and properly structured one-level-deep references to real bundle files. It lands at the top anchor across all dimensions.

Dimension	Reasoning	Score
Conciseness	The body is lean and example-driven — brief DO/DON'T lists and rustdoc code templates with no padding or explanation of concepts Claude already knows; every section earns its place.	3 / 3
Actionability	Provides concrete, copy-paste-ready rustdoc comment templates and an executable verification command ('cargo doc --no-deps --all-features'); below would be pseudocode or vague direction.	3 / 3
Workflow Clarity	Sequences principles → patterns → verification with an explicit 'cargo doc' checkpoint; as a patterns skill it is unambiguous and includes a validation step, so no destructive-operation cap applies.	3 / 3
Progressive Disclosure	Body is a concise overview with a clearly signaled References section pointing one level deep to four real files (function-, type-, error-, examples-and-links documentation); all referenced paths exist in ./references/.	3 / 3
	Total	12 / 12 Passed

Description

100%

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 highly specific, third-person description that clearly states capabilities and explicit use-when triggers scoped to Rust documentation. It hits the top anchor on every dimension without verbosity.

Dimension	Reasoning	Score
Specificity	Lists multiple concrete actions — 'writing doc comments, documenting functions/types/traits/modules, creating error sections, using intra-doc links, or following rustdoc conventions' — matching the highest anchor.	3 / 3
Completeness	Explicitly answers both what ('Rust documentation practices for HASH codebase') and when ('Use when writing doc comments...'); a missing 'Use when' clause would cap it at 2, but it is present.	3 / 3
Trigger Term Quality	Covers natural terms a user would say ('doc comments', 'rustdoc', 'intra-doc links', 'documentation'); below would lack these variations, above is the ceiling.	3 / 3
Distinctiveness Conflict Risk	Scoped to Rust documentation for the HASH codebase with distinct rustdoc-specific triggers, unlikely to conflict with other skills.	3 / 3
	Total	12 / 12 Passed

Validation

87%

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 — 14 / 16 Passed

Validation for skill structure

Criteria	Description	Result
metadata_version	'metadata.version' is missing	Warning
metadata_field	'metadata' should map string keys to string values	Warning

	Total	14 / 16 Passed

Repository: hashintel/hash
Path: .claude/skills/documenting-rust-code/SKILL.md
Commit: 4f2d2ce

Reviewed: about 5 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.