rustdoc-library-documentation

Original：🇺🇸 English

Translated

Write and review Rust library documentation with rustdoc module docs, public API examples, doctests, examples directories, missing-docs gates, docs.rs readiness, and user-first crate narratives. Use when documenting a Rust crate, improving docs before publishing, or turning examples into tested rustdoc.

19installs

Sourcelvtd-llc/skills

Added on2026-09-06

NPX Install

npx skill4agent add lvtd-llc/skills rustdoc-library-documentation

SKILL.md Content

View Translation Comparison →

Rustdoc Library Documentation

Use this skill to make Rust library documentation executable, navigable, and useful to downstream crate consumers.

Core Workflow

Start from the consumer's first task, not from internal module order.
Add crate-level and module-level docs that explain purpose and boundaries.
Document public types, functions, errors, features, and invariants.
Prefer short compiling examples and doctests for core APIs.
Put longer scenarios in
```
examples/
```
and reference them from docs.
Run docs and doctests before publishing.

Task	Load
Document a public crate API	`guidelines.md` , `workflows/document-library.md`
Add doctests or examples	`references/rustdoc-patterns.md`
Prepare docs for publishing	`references/rustdoc-patterns.md`

Source Notes

Guidance is transformed and paraphrased from Herbert Wolverson, Advanced Hands-On Rust, especially Chapter 4 on documenting a library and Chapter 15 on sharing crates. Examples are original skeletons.