write-documentation

write-documentation is a skill for Claude Code, Codex from r3bl-org/r3bl-open-core. It costs 0 tokens per session (10,686 once invoked), scanned A, original, Apache-2.0.

A style guide for writing Rust documentation comments, called rustdoc. It covers wording, structure, links to code, numeric constants, tables, and terminal-control notation.

In plain words
What is it for?
For creating or reviewing Rust documentation comments and fixing broken links, formatting, tables, or constant descriptions.
Why use it?
It helps developers write documentation that is consistent, precise, readable, and correctly linked to the code.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one. Also seen: installed under .agents/ (shared by several agents).

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/r3bl-org/r3bl-open-core/write-documentation
Any agent
npx skills add r3bl-org/r3bl-open-core --skill write-documentation
Clone the repo
git clone --depth 1 https://github.com/r3bl-org/r3bl-open-core

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for write-documentation

README.md
[![agentmods](https://agentmods.dev/badge/skills/r3bl-org/r3bl-open-core/write-documentation.svg)](https://agentmods.dev/skills/r3bl-org/r3bl-open-core/write-documentation)
Your own site
<a href="https://agentmods.dev/skills/r3bl-org/r3bl-open-core/write-documentation"><img src="https://agentmods.dev/badge/skills/r3bl-org/r3bl-open-core/write-documentation.svg" alt="Measured on agentmods" height="20"></a>
Per session 0 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 10,686 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00000 $0.10686
Opus 5 $0.00000 $0.05343
Sonnet 5 $0.00000 $0.02137
Haiku 4.5 $0.00000 $0.01069

Measured 6d ago against content hash d88274798698, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-05, from the pricing page.

Security

Grade A, and why

write-documentation scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 6d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.agents/skills/write-documentation/SKILL.md · 1,186 lines

How it starts

The opening of the file, as written. The whole thing — 1,186 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Writing Good Rust Documentation

This consolidated skill covers all aspects of writing high-quality rustdoc:

  1. Voice & Tone - Serious, meaningful, precise, and fun
  2. Prose Style - Opening lines, explicit subjects, verb tense
  3. Structure - Inverted pyramid principle
  4. Links - Intra-doc link patterns
  5. Constants - Human-readable numeric literals
  6. Formatting - Markdown tables and cargo rustdoc-fmt
  7. ANSI Escape Codes - Spaced ESC [ notation (see ansi-escape-codes.md)

When to Use

Proactively (While Writing Code)

  • Writing new code that includes /// or //! doc comments
  • Creating new modules, traits, structs, or functions
  • Adding links to other types or modules in documentation
  • Defining byte/u8 constants

Retroactively (Fixing Issues)

  • /fix-intradoc-links - Fix broken links, convert inline to reference-style
  • /fix-comments - Fix constant conventions in doc comments
  • /fix-md-tables - Fix markdown table formatting
  • /docs - Full documentation check and fix

Voice & Tone

r3bl is serious & meaningful & precise. r3bl is also fun.

Documentation should be rigorous about content, playful about presentation:

Aspect Serious & Precise Fun
Technical accuracy Correct terminology, proper distinctions -
Links Intra-doc links, authoritative sources -
Visual aids ASCII diagrams, tables Emoji for scannability
Language Clear, unambiguous Literary references, personality

Examples

Emoji for visual scanning (semantic, not decorative):

//! 🐧 **Linux**: Uses `epoll` for I/O multiplexing
//! 🍎 **macOS**: Uses `kqueue` (with PTY limitations)
//! 🪟 **Windows**: Uses IOCP for async I/O

Severity with visual metaphors:

//! 1. 🐢 **Multi-threaded runtime**: Reduced throughput but still running
//! 2. 🧊 **Single-threaded runtime**: Total blockage - nothing else runs

Literary references with layered meaning:

//! What's in a name? 😛 The three core properties:

The 😛 is a visual pun on "tongue in cheek" - Shakespeare's Juliet argues names don't matter, but here we use the quote to explain why RRT's name does matter. The emoji signals the irony.

Read the full file on GitHub · 1,186 lines

Files

What ships with it

6 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 6d ago First seen · 1,186 lines · 0 tokens per session scan A d88274798698

Subscribe to this mod's changes

write-documentation is a skill published in the GitHub repository r3bl-org/r3bl-open-core (483 stars, last pushed yesterday), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 10,686 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

rust-check

Run cargo check on the current Rust project to find compile errors.

Hmbown/CodeWhale · 15 tokens

rust-unit-tests

Write, improve, and run Rust unit tests in the warp Rust codebase.

warpdotdev/warp · 20 tokens

Hex1b.McpServer

This skill provides guidance for AI agents working with the Hex1b TUI (Terminal User Interface) library and its MCP diagnostic tools.

mitchdenny/hex1b · 0 tokens

split-crate-by-responsibility

Use when refactoring Rust monoliths by extracting crates or modules, especially when a user asks to split a huge .rs file, move responsibilities out of an app crate, reduce crate scope, avoid one-file crates, or verify that a new crate owns real behavior rather than becoming a lib.rs bucket.

AnalyseDeCircuit/oxideterm · 69 tokens

rust-learner

Use when asking about Rust versions or crate info. Keywords: latest version, what's new, changelog, Rust 1.x, Rust release, stable, nightly, crate info, crates.io, lib.rs, docs.rs, API documentation, crate features, dependencies, which crate, what version, Rust edition, edition 2021, edition 2024, cargo add, cargo…

kikakkz/wait-agent · 123 tokens

rust-router

CRITICAL: Use for ALL Rust questions including errors, design, and coding. HIGHEST PRIORITY for: 比较, 对比, compare, vs, versus, 区别, difference, 最佳实践, best practice, tokio vs, async-std vs, 比较 tokio, 比较 async, Triggers on: Rust, cargo, rustc, crate, Cargo.toml, 意图分析, 问题分析, 语义分析, analyze intent, question analysis, compile…

kikakkz/wait-agent · 280 tokens