关于 rustdoc-library-documentation
rustdoc-library-documentation 是一项帮助 Rust 库维护者编写可执行、易导航文档的技能，侧重消费者使用路径、公共 API 文档和 doctest。
主要功能
- 01按消费者任务组织文档
- 02编写 crate 与模块说明
- 03记录公共 API 与不变量
- 04添加可编译示例和 doctest
- 05发布前运行文档测试
适用场景
- 01为 Rust 库补充 crate 文档
- 02记录函数、类型与错误
- 03为核心 API 编写 doctest
- 04发布前检查文档和示例
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/rustdoc-library-documentation确认已加载。
包含的文件
除 SKILL.md 外，安装时一起下载的参考资料和脚本。
guidelines.mdagents/openai.yamlreferences/rustdoc-patterns.mdworkflows/document-library.md详细介绍
Rustdoc 库文档
使用此技能，让 Rust 库文档可执行、易于导航，并对下游 crate 的使用者有用。
核心工作流
- 从使用者的首要任务入手，而非按内部模块的顺序编写。
- 添加 crate 级和模块级文档，说明用途和边界。
- 记录公开类型、函数、错误、功能和不变量。
- 优先采用简短且可编译的示例，并为核心 API 编写 doctest。
- 将较长的使用场景放入
examples/，并在文档中引用。 - 发布前运行文档和 doctest。
接下来阅读
| 任务 | 加载 |
|---|---|
| 为公开 crate API 编写文档 | guidelines.md、workflows/document-library.md |
| 添加 doctest 或示例 | references/rustdoc-patterns.md |
| 准备发布文档 | references/rustdoc-patterns.md |
来源说明
本指南改编并转述自 Herbert Wolverson 的《Advanced Hands-On Rust》，尤其是第 4 章“为库编写文档”和第 15 章“共享 crate”。示例为原创框架。
评论
支持 Markdown