agentskills.codes
DO

documenting-rust-code

by hashintelWritingSource

Guidelines for writing high-quality Rust documentation following industry standards.

DocumentationCode ReviewRust

Install

mkdir -p .claude/skills/documenting-rust-code && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/3502" && unzip -o skill.zip -d .claude/skills/documenting-rust-code && rm skill.zip

Installs to .claude/skills/documenting-rust-code

Activation

This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.

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.
204 chars✓ has a “when” trigger
Beginner

Key capabilities

  • →Write doc comments with summaries
  • →Create intra-doc links for types
  • →Document error conditions
  • →Include practical API examples
  • →Format module-level documentation

How it works

The skill enforces rustdoc conventions by requiring summaries, error sections, and intra-doc links for all public APIs.

Inputs & outputs

You give it
Rust source code
You get back
Compliant documentation comments

When to use documenting-rust-code

  • →Write module doc comments
  • →Add error sections to documentation
  • →Link to standard library types
  • →Document a public trait

About documenting-rust-code

Enforces consistent documentation practices including intra-doc linking, error handling sections, and usage examples. Ensures that public APIs are well-documented for end users.

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.

When not to use it

  • →Documenting standard trait implementations

Prerequisites

cargo doc

Limitations

  • →Requires manual maintenance of doc comments
  • →Limited to Rust documentation conventions

How it compares

It mandates a high-quality standard similar to major Rust crates, ensuring consistency across the entire codebase.

Compared to similar skills

documenting-rust-code side by side with the closest alternatives in the catalog.

SkillInstallsUpdatedSafetyDifficulty
documenting-rust-code (this skill)14moReviewBeginner
review-rust-docs17moNo flagsBeginner
deepwiki-rs2511moReviewIntermediate
code-review08moNo flagsIntermediate

Try saying

Example prompts that trigger this skill in your AI assistant.

More by hashintel

View all by hashintel →

handling-rust-errors

hashintel

HASH error handling patterns using error-stack crate. Use when working with Result types, Report types, defining custom errors, propagating errors with change_context, adding context with attach, implementing Error trait, or documenting error conditions in Rust code.

46

exploring-rust-crates

hashintel

Generate Rust documentation to understand crate APIs, structure, and usage. Use when exploring Rust code, understanding crate organization, finding functions/types/traits, or needing context about a Rust package in the HASH workspace.

33

writing-hashql-jexpr

hashintel

HashQL J-Expr syntax for writing queries. Use when writing J-Expr code, using #literal/#struct/#list constructs, understanding function call syntax, or working with HashQL query files (.jsonc).

25

managing-cargo-dependencies

hashintel

Cargo.toml dependency management patterns for HASH workspace. Use when adding, updating, or removing dependencies, organizing Cargo.toml sections, configuring version pinning and default features, or managing public dependencies.

13

managing-git-workflow

hashintel

Git workflow for HASH including branch naming, PR creation, and PR reviews. Use when creating branches, making commits, opening pull requests, or reviewing PRs.

12

testing-hashql

hashintel

HashQL testing strategies including compiletest (UI tests), unit tests, and snapshot tests. Use when writing tests for HashQL code, using //~ annotations, running --bless, debugging test failures, or choosing the right testing approach.

11

You might also like

review-rust-docs

RediSearch

Review the documentation of a Rust crate to ensure it meets our requirements and standards.

12

deepwiki-rs

sopaco

AI-powered Rust documentation generation engine for comprehensive codebase analysis, C4 architecture diagrams, and automated technical documentation. Use when Claude needs to analyze source code, understand software architecture, generate technical specs, or create professional documentation from any programming language.

25170

code-review

jonatron55

Instructions for reviewing changes and ensuring quality before completion. Use when asking for a review or before committing changes.

00

rust-docs-guidelines

RediSearch

Guidelines for writing Rust documentation

7147

write-documentation

r3bl-org

Write and format Rust documentation correctly. Apply proactively when writing code with rustdoc comments (//! or ///). Covers voice & tone, prose style (opening lines, explicit subjects, verb tense), structure (inverted pyramid), intra-doc links (crate:: paths, reference-style), constant conventions (binary/byte literal/decimal), and formatting (cargo rustdoc-fmt). Also use retroactively via /fix-intradoc-links, /fix-comments, or /fix-md-tables commands.

15

doc-cli-usage

BA-CalderonMorales

Use the Rust-based documentation CLI for common tasks.

00

Search skills

Search the agent skills registry