rustdoc-library-documentation
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.
- License 许可
- MIT
- 最近更新
- 2026-11-14
- Stars
- ★ 1.6k
- Forks
- 491
01 前言 Front Matter
- name
- rustdoc-library-documentation
- license
- MIT
- metadata
- { "tags": "rust,rustdoc,documentation,doctests,library", "version": "0.1.0", "category": "Rust", "displayName": "Rustdoc Library Documentation" }
- description
- 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.
- compatibility
- Codex, Claude Code, and other Agent Skills-compatible clients.
02 资源文件 4
- 参考文档agents/openai.yaml225 B
- 参考文档guidelines.md1.3 KB
- 参考文档references/rustdoc-patterns.md2.2 KB
- 参考文档workflows/document-library.md1.9 KB
03 SKILL.md 正文
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.
Read Next
| 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.
04 同仓库更多 Skills
worktable-review-with-annotations
Create, inspect, reply to, update, or resolve situated Worktable annotations. Use when feedback belongs to a Doc section, block, text range, or HTML Doc, or when the user asks to address existing review feedback and coordinate a requested artifact edit.
worktable-find-and-synthesize-context
Find, assess, and synthesize context from Worktable Docs and Records. Use when the user asks what a workspace contains, wants workspace-backed research, needs current facts reconciled across artifacts, or requests a cited synthesis without changing workspace state.
worktable-create-or-update-docs
Create, edit, rename, or maintain narrative Worktable Docs. Use for plans, decisions, briefs, notes, research syntheses, and other durable prose when the user requests a new artifact or a safe update to an existing one.
worktable-create-or-manage-records
Organize repeated structured information as durable Worktable Records. Use for research datasets, inventories, directories, pipelines, trackers, and other collections whose items need identity, fields, filtering, links, validation, or individual updates.
worktable-create-or-manage-interactive-html
Create or improve durable visual and interactive artifacts in Worktable. Use for dashboards, trackers, calculators, mini apps, slide presentations, and other requests that benefit from a polished HTML Doc.
worktable-collaborate-threads
Read, answer, and hand off messages through durable Worktable threads with users or other authenticated participants. Use when the user asks to check addressed messages, reply to a participant, continue a thread, request another agent's help, wait briefly for a response, or watch for comments and messages sent to the agent.