CtrlK
BlogDocsLog inGet started
Tessl Logo

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.

72

Quality

89%

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

86%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, actionable reference that keeps the overview inline and delegates detail to four real, clearly-labeled reference files. Code patterns are concrete and copy-paste-ready, with a verification step included; only minor intro padding and implicit workflow sequencing limit the top of the scale.

Suggestions

Trim the opening 'Comprehensive guidance on documenting Rust code in the HASH repository following rustdoc conventions.' and the 'Follow high-quality standards like time, jiff, and serde' framing to tighten conciseness.

Make the write-document-then-verify workflow explicit (e.g. a short numbered sequence ending in `cargo doc --no-deps --all-features`) so the validation checkpoint is clearly sequenced rather than implied.

DimensionReasoningScore

Conciseness

Mostly lean reference material (DO/DON'T lists, code patterns), with only minor padding such as 'Comprehensive guidance on documenting Rust code...' and 'Follow high-quality standards like time, jiff, and serde' that could be trimmed.

4 / 5

Actionability

Provides concrete, copy-paste-ready rustdoc patterns (doc comments, intra-doc links, # Errors, # Arguments, module docs, examples) plus an executable `cargo doc --no-deps --all-features` verification command covering the common cases.

5 / 5

Workflow Clarity

A patterns reference rather than a destructive multi-step workflow, but it includes an explicit Verification checkpoint (`cargo doc --no-deps --all-features`); sequence is implicit and validation is present with minor gaps.

4 / 5

Progressive Disclosure

Clear overview with well-signaled, one-level-deep references — all four linked files (function-documentation.md, type-documentation.md, error-documentation.md, examples-and-links.md) exist and are described, with key examples kept inline.

5 / 5

Total

18

/

20

Passed

Description

92%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, well-scoped description that clearly states the capability and provides an explicit 'Use when' trigger clause with concrete, natural keywords. It is concise, third-person, and distinct within the Rust documentation niche.

DimensionReasoningScore

Specificity

Lists multiple concrete actions — 'writing doc comments, documenting functions/types/traits/modules, creating error sections, using intra-doc links, or following rustdoc conventions' — giving comprehensive coverage of the documentation domain.

5 / 5

Completeness

Explicitly answers both 'what' (Rust documentation practices for the HASH codebase) and 'when' via a concrete 'Use when writing doc comments...' trigger clause.

5 / 5

Trigger Term Quality

Good natural keyword coverage ('doc comments', 'rustdoc', 'intra-doc links', 'error sections') that users would actually say, though a few synonyms are missing.

4 / 5

Distinctiveness Conflict Risk

Scoped to Rust/HASH documentation with distinct triggers (rustdoc, intra-doc links), giving a clear niche with minimal conflict risk against other skills.

5 / 5

Total

19

/

20

Passed

Validation

87%

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

Validation14 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

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