Rust Module Documenter skill for Claude and Codex
A complete markdown API reference for a Rust module, built from its source: overview, table of contents, a subsection with signature and description for every…
Install it once and Claude or Codex runs it for you. When your request matches, your AI loads the skill, asks for anything it is missing, and works through the template itself. Prefer to fill it in by hand? See the full prompt template.
Download the skill (.zip) · View SKILL.md
When it is used
Use when a Rust module's public items need a markdown API reference with signatures, descriptions, and examples pitched at a chosen audience. Do not use for generating rustdoc comments inside the source, reviewing the module, or writing a README for the whole crate. Related topics: coding, rust.
What it will ask you for
- Module source (longer free text)
- Include private items (choose one: Yes, No)
- Style (choose one: Brief, Detailed, Mixed)
- Audience (choose one: Beginners, Intermediate, Advanced)
- Extra sections (choose any: Usage examples, Safety notes, Performance considerations, Compatibility notes)
- Output file name (free text, e.g. "module_docs.md")
How it works
- Extract every public item with its exact signature and existing doc comment, keeping accurate wording from the source.
- Write the level-1 heading, a two-paragraph overview, and a table of contents linking to every section.
- Give each item its own subsection with the signature in a rust code block and a description at the chosen style and audience level.
- Add the selected extra sections, making every usage example compile as a doctest and listing each unsafe invariant under safety notes.
- List private items in their own section only when requested, then check every link in the table of contents resolves.
What you get
A markdown document opening with a level-1 heading and table of contents, then one subsection per item with signature and description, then the selected extra sections.
What it watches out for
- Paraphrasing a signature instead of copying it, so the documented types drift from the code.
- Writing usage examples that do not compile as doctests, which fail the moment someone runs cargo test.
- Documenting private helpers alongside public items without the toggle set, which clutters the reference and exposes internals.
How to install
Claude.ai and the Claude desktop app
- Download the skill .zip.
- Open Settings, then Capabilities, and find Skills.
- Choose Upload skill and select the .zip.
- Ask Claude for help with the task. It loads the skill when your request matches.
Claude Code
- Download the skill .zip.
- Unzip it into ~/.claude/skills/ (or .claude/skills/ inside a project).
- Start a new session. Claude Code loads the skill when your request matches.
Codex
- Download the skill .zip.
- Unzip it into ~/.agents/skills/ (or .agents/skills/ inside a project).
- Codex picks it up on its own. Type $ and the skill name to use it, or just ask for the task.
Cursor
- Download the Cursor rule (.mdc).
- Save it in .cursor/rules/ inside your project.
- Cursor's agent applies the rule when your request matches its description.
AGENTS.md (Codex, Cursor, and other coding agents)
- Copy the AGENTS.md section.
- Paste it into AGENTS.md at the root of your repository, creating the file if needed.
- Coding agents that read AGENTS.md follow it when your request fits.