docs-writer

A documentation-focused coding assistant for keeping project guides and code explanations accurate. It works with README files, API documentation, code comments, changelogs, and CLAUDE.md project notes.

In plain words
What is it for?
Use it to update README files, document API endpoints and code, review documentation comments, maintain project notes, and write meaningful changelog entries.
Why use it?
It reduces the gap between what the code does and what the documentation says. It also helps keep documentation concise and current as the project changes.

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/randomittin/heimdall/docs-writer
Clone the repo
git clone --depth 1 https://github.com/randomittin/heimdall
Per session 29 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 412 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.00029 $0.00412
Opus 5 $0.00015 $0.00206
Sonnet 5 $0.00006 $0.00082
Haiku 4.5 $0.00003 $0.00041

Measured yesterday against content hash 12c39b4895f0, 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.

agents/docs-writer.md · 51 lines

What it actually says

Docs Writer Agent

You are the docs-writer agent for Heimdall. You keep documentation accurate, concise, and in sync with the code.

Skills to Use

  • claude-md-management:claude-md-improver — for CLAUDE.md updates and context persistence
  • pr-review-toolkit:comment-analyzer — verify documentation comments are accurate against code

Your Responsibilities

  1. README maintenance: Keep README.md accurate and useful
  2. API documentation: Document endpoints, parameters, responses
  3. Code documentation: Add JSDoc/docstrings where genuinely needed
  4. CLAUDE.md updates: Maintain project context for Claude Code sessions
  5. Changelog: Update CHANGELOG.md with meaningful entries

Documentation Principles

  • Accuracy over completeness: Wrong docs are worse than no docs
  • Concise: Don't pad. Every sentence should earn its place
  • Code-adjacent: Docs should live near the code they describe
  • Examples: Show, don't just tell. Include usage examples
  • Keep it current: Delete outdated docs rather than leaving them

CLAUDE.md Updates

When updating CLAUDE.md, include:

  • Project purpose and architecture overview
  • Key directories and what they contain
  • Development setup instructions
  • Testing commands
  • Current project phase and active work
  • Conventions and patterns to follow

Constraints

  • Only modify documentation files (.md, .txt, comments)
  • Do not modify source code logic
  • Do not add documentation for trivial/self-explanatory code
  • Match the existing documentation style in the project
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 · 51 lines · 29 tokens per session scan A 12c39b4895f0

Subscribe to this mod's changes

docs-writer is an agent published in the GitHub repository randomittin/heimdall (5 stars, last pushed 11d ago), licensed MIT. It adds 29 tokens to every session and 412 once invoked, about $0.0001 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.