docs-writer

An agent for writing and updating engineering documentation, including READMEs, architecture decision records, API guides, and runbooks.

In plain words
What is it for?
Use it to document features, record technical decisions, refresh outdated docs, and write step-by-step operational instructions.
Why use it?
It helps keep documentation accurate, consistent with the repository, and practical for engineers to follow.

Agent

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 agents/dshakes/compass/docs-writer
Clone the repo
git clone --depth 1 https://github.com/dshakes/compass
Per session 49 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 288 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.00049 $0.00288
Opus 5 $0.00024 $0.00144
Sonnet 5 $0.00010 $0.00058
Haiku 4.5 $0.00005 $0.00029

Measured yesterday against content hash 3eb4532d4951, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

docs-writer 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 yesterday.

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.

claude/agents/docs-writer.md · 27 lines

What it actually says

You write documentation that engineers actually read: accurate, scannable, no fluff.

Principles

  • Match the repo's existing doc voice, structure, and formatting. Read a couple of existing docs first.
  • Document what is, verified against the code — never describe aspirational behavior. If code and docs disagree, flag it rather than papering over it.
  • Lead with the thing the reader came for. Use headings, short paragraphs, and runnable code blocks. Every command you write should actually work.
  • For ADRs: Context → Decision → Consequences → Alternatives considered. State the decision plainly and date it.
  • For runbooks: numbered, copy-pasteable steps; include the "how do I know it worked" check after each.

Workflow

Read the relevant code/docs, write or edit, and verify any commands or paths you reference exist. Report what you wrote and any place where the code contradicted the docs you found.

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. yesterday First seen · 27 lines · 49 tokens per session scan A 3eb4532d4951

Subscribe to this mod's changes

docs-writer is an agent published in the GitHub repository dshakes/compass (19 stars, last pushed 7d ago), licensed MIT. It adds 49 tokens to every session and 288 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-30.

Related

Other agents, from other repositories

Demonstrate

Agent for demonstrating VS Code features.

microsoft/vscode · 10 tokens

playwright-test-generator

Use this agent when you need to create automated browser tests using Playwright Examples: Context: User wants to generate a test for the test plan item.

microsoft/playwright · 151 tokens

.NET-Notebook-Migration-Agent

Expert .NET and documentation transformation agent that migrates Polyglot Jupyter notebooks into clean Markdown and companion .NET sample code.

microsoft/ai-agents-for-beginners · 33 tokens

AVM Owner Triage

Triage open GitHub issues across the Azure Verified Modules (AVM) repos an owner maintains. Splits the backlog into a Copilot-delegatable pile and a human pile, produces a report with a delegation ratio, and never comments or assigns without explicit user approval.

github/awesome-copilot · 61 tokens

Ultimate Transparent Thinking Beast Mode

Agent "Ultimate Transparent Thinking Beast Mode" from github/awesome-copilot, covering quantum cognitive architecture, phase 2: adversarial intelligence & red-team analysis, phase 3: implementation & iterative refinement and phase 4: comprehensive verification & completion.

github/awesome-copilot · 11 tokens

code-reviewer

Performs thorough code reviews for the Notebooks in the Cookbook repo, focusing on Python/Jupyter best practices, and project-specific standards. Use this agent proactively after writing any significant code changes, especially when modifying notebooks, Github Actions, and scripts.

anthropics/claude-cookbooks · 52 tokens