documenting-systems

documenting-systems is a skill for Claude Code, Codex from rileyhilliard/agentrc. It costs 31 tokens per session (484 once invoked), scanned A, original, MIT.

A method for writing technical documentation in layers, starting with the information needed for the immediate task.

In plain words
What is it for?
It is for writing READMEs, API documentation, architecture notes, and other task-focused Markdown documents.
Why use it?
It helps readers find practical instructions without being overwhelmed by details they do not yet need.

Skill for Claude CodeCodex

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/rileyhilliard/agentrc/documenting-systems
Any agent
npx skills add rileyhilliard/agentrc --skill documenting-systems
Clone the repo
git clone --depth 1 https://github.com/rileyhilliard/agentrc

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 documenting-systems

README.md
[![agentmods](https://agentmods.dev/badge/skills/rileyhilliard/agentrc/documenting-systems.svg)](https://agentmods.dev/skills/rileyhilliard/agentrc/documenting-systems)
Your own site
<a href="https://agentmods.dev/skills/rileyhilliard/agentrc/documenting-systems"><img src="https://agentmods.dev/badge/skills/rileyhilliard/agentrc/documenting-systems.svg" alt="Measured on agentmods" height="20"></a>
Per session 31 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 484 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 $0.00031 $0.00484
Opus 5 $0.00015 $0.00242
Sonnet 5 $0.00006 $0.00097
Haiku 4.5 $0.00003 $0.00048

Measured 4d ago against content hash 6de70f4c48c4, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

documenting-systems 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 4d 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.

.agentrc/skills/documenting-systems/SKILL.md · 73 lines

What it actually says

Technical Documentation

For writing style, tone, and voice guidance, use Skill(ce:writer) with The Engineer persona.

Core Principles

1. Progressive Disclosure

Reveal information in layers:

Layer Content User Question
1 One-sentence description What is it?
2 Quick start code block How do I use it?
3 Full API reference What are my options?
4 Architecture deep dive How does it work?

Warnings, breaking changes, and prerequisites go at the TOP.

2. Task-Oriented Writing

<!-- Bad: Feature-oriented -->
## AuthService Class
The AuthService class provides authentication methods...

<!-- Good: Task-oriented -->
## Authenticating Users
To authenticate a user, call login() with credentials:

3. Show, Don't Tell

Every concept needs a concrete example.

Formatting Standards

  • Sentence case headings: "Getting started" not "Getting Started"
  • Max 3 heading levels: Deeper means split the doc
  • Always specify language in code blocks
  • Relative paths for internal links
  • Tables for structured data with 3+ attributes

Quality Checklist

  • Code examples tested and runnable
  • No placeholder text or TODOs
  • Matches actual code behavior
  • Scannable without reading everything
  • Reader knows what to do next

Anti-Patterns

Problem Fix
Wall of text Break up with headings, bullets, code, tables
Buried critical info Warnings/breaking changes at TOP
Missing error docs Always document what can go wrong

Templates

For README, API endpoint, and file organization templates, see references/templates.md.

  • Skill(ce:writer) - Writing style, tone, and voice (load The Engineer persona)
  • Skill(ce:visualizing-with-mermaid) - Architecture and flow diagrams
Files

What ships with it

1 file 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. 4d ago First seen · 73 lines · 31 tokens per session scan A 6de70f4c48c4

Subscribe to this mod's changes

documenting-systems is a skill published in the GitHub repository rileyhilliard/agentrc (3 stars, last pushed 6mo ago), licensed MIT. It adds 31 tokens to every session and 484 once invoked, about $0.0002 per session on Opus 5. 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-31.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation.

obra/superpowers · 37 tokens

auto-perf-optimize

Run agent-driven VS Code performance or memory investigations. Use when asked to launch Code OSS, automate a VS Code scenario, run the Chat memory smoke runner, capture renderer heap snapshots, take workflow screenshots, compare run summaries, or drive a repeatable scenario before heap-snapshot analysis.

microsoft/vscode · 62 tokens

chat-perf

Run chat perf benchmarks and memory leak checks against the local dev build or any published VS Code version. Use when investigating chat rendering regressions, validating perf-sensitive changes to chat UI, or checking for memory leaks in the chat response pipeline.

microsoft/vscode · 51 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens