# Rust Docs Guidelines > Guidelines for writing Rust documentation Use when this capability is needed. - Skill: `tomevault-io/rust-docs-guidelines` (Agent Skill, multi-file: 2 files) - Install (CLI): `npx skillmds@latest add tomevault-io/rust-docs-guidelines` - Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/rust-docs-guidelines/raw - Safety review: pending (external: skill-scanner PASS, skillspector PASS) - Works with: Claude Code, Claude.ai, OpenAI Codex - Category: Docs & Writing - Author: tomevault-io (https://skillmd.com/u/tomevault-io) - Updated: 2026-09-17 - Page: https://skillmd.com/skills/tomevault-io/rust-docs-guidelines --- # Rust Docs Guidelines Standards to follow when writing Rust documentation. ## Guidelines - Key concepts should be explained only once. All other documentation should use an intra-documentation link to the first explanation. - Always use an intra-documentation link when mentioning a Rust symbol (type, function, constant, etc.). - Avoid referring to specific lines or line ranges, as they may change over time. Use line comments if the documentation needs to be attached to a specific code section inside a function/method body. - Focus on why, not how. In particular, avoid explaining trivial implementation details in line comments. - Refer to constants using intra-documentation links. Don't hard-code their values in the documentation of other items. - Intra-documentation links to private items are preferable to duplication. Add `#[allow(rustdoc::private_intra_doc_links)]` where relevant. --- > Source: [zjunlp/Skills](https://github.com/zjunlp/Skills) — distributed by [TomeVault](https://tomevault.io).