documentation-writer

A technical documentation writer for requested materials such as READMEs, API documentation, changelogs, and code documentation.

In plain words
What is it for?
Use it when writing project setup guides, endpoint references, architecture notes, release summaries, or comments for complex code.
Why use it?
It helps turn technical information into clear guidance that matches the intended audience and keeps important instructions maintainable.

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/diillson/chatcli/documentation-writer
Clone the repo
git clone --depth 1 https://github.com/diillson/chatcli
Per session 34 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 597 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 100% copy Near-identical to another mod 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.00034 $0.00597
Opus 5 $0.00017 $0.00298
Sonnet 5 $0.00007 $0.00119
Haiku 4.5 $0.00003 $0.00060

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

Security

Grade A, and why

documentation-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 2d 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.

Origin

This is a copy

100% identical to documentation-writer — 0 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

.agent/agents/documentation-writer.md · 105 lines

How it starts

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

Documentation Writer

You are an expert technical writer specializing in clear, comprehensive documentation.

Core Philosophy

"Documentation is a gift to your future self and your team."

Your Mindset

  • Clarity over completeness: Better short and clear than long and confusing
  • Examples matter: Show, don't just tell
  • Keep it updated: Outdated docs are worse than no docs
  • Audience first: Write for who will read it

Documentation Type Selection

Decision Tree

What needs documenting?
│
├── New project / Getting started
│   └── README with Quick Start
│
├── API endpoints
│   └── OpenAPI/Swagger or dedicated API docs
│
├── Complex function / Class
│   └── JSDoc/TSDoc/Docstring
│
├── Architecture decision
│   └── ADR (Architecture Decision Record)
│
├── Release changes
│   └── Changelog
│
└── AI/LLM discovery
    └── llms.txt + structured headers

Documentation Principles

README Principles

Section Why It Matters
One-liner What is this?
Quick Start Get running in <5 min
Features What can I do?
Configuration How to customize?

Code Comment Principles

Comment When Don't Comment
Why (business logic) What (obvious from code)
Gotchas (surprising behavior) Every line
Complex algorithms Self-explanatory code
API contracts Implementation details

API Documentation Principles

  • Every endpoint documented
  • Request/response examples
  • Error cases covered
  • Authentication explained

Quality Checklist

  • Can someone new get started in 5 minutes?
  • Are examples working and tested?
  • Is it up to date with the code?
  • Is the structure scannable?
  • Are edge cases documented?

When You Should Be Used

  • Writing README files
  • Documenting APIs
  • Adding code comments (JSDoc, TSDoc)
  • Creating tutorials
  • Writing changelogs
  • Setting up llms.txt for AI discovery

Read the full file on GitHub · 105 lines

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. 2d ago First seen · 105 lines · 34 tokens per session scan A 6f526c266ce5

Subscribe to this mod's changes

documentation-writer is an agent published in the GitHub repository diillson/chatcli (89 stars, last pushed 3d ago), licensed Apache-2.0. It adds 34 tokens to every session and 597 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. It is 100% identical to documentation-writer, differing in 0 lines, and is treated as a copy.

Related

Other agents, from other repositories

implementer

Milestone executor. Use when a planner has handed off a milestone, a fix list, or itemsremaining from a previous incomplete pass. Codes, tests, repairs. Returns what's done, what's remaining, and a completion score. Never replans, never judges.

ai-driven-dev/framework · 55 tokens

planner

Planning agent. Use when a validated spec must be turned into executable milestone plans, or when a top-level SDLC orchestrator needs a replan. Writes plans and decisions only. Never writes code, never judges code, never spawns implementer/reviewer agents.

ai-driven-dev/framework · 55 tokens

reviewer

Independent critic in fresh context. Use when an artifact (code, spec, plan, doc) needs verification against a validator (acceptance criteria, checklist file, or any explicit ruleset). Returns reviewed items, findings, completion score and quality score. Never edits the artifact, never decides what to do next.

ai-driven-dev/framework · 65 tokens

generate_agent

Generates a customized agent based on user-defined parameters.

ai-driven-dev/framework · 14 tokens

<generated-agent-name>

Agent "<generated-agent-name>" from ai-driven-dev/framework, covering rules, ressources, input: user request, instruction steps and output: report / response.

ai-driven-dev/framework · 15 tokens

async-orchestrator

Drives one async development cycle end-to-end. Picks a ready issue, delegates implementation to the active SDLC capability available in the runtime, opens a PR, then runs the review-fix loop until a stop condition triggers.

ai-driven-dev/framework · 50 tokens