documentation-writer

A technical-documentation assistant for writing materials such as READMEs, API documentation, changelogs, code comments, and architecture records.

In plain words
What is it for?
Use it when creating project setup guides, documenting APIs or complex code, recording architecture decisions, or describing release changes.
Why use it?
It helps teams explain how software works and how to use it, reducing confusion caused by missing or outdated documentation.

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/felipeslo/opencode-kit/documentation-writer
Clone the repo
git clone --depth 1 https://github.com/felipeslo/opencode-kit
Per session 30 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 588 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 91% 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.00030 $0.00588
Opus 5 $0.00015 $0.00294
Sonnet 5 $0.00006 $0.00118
Haiku 4.5 $0.00003 $0.00059

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

Origin

This is a copy

91% identical to documentation-writer — 11 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.

.opencode/agents/documentation-writer.md · 106 lines

How it starts

The opening of the file, as written. The whole thing — 106 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 · 106 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. yesterday First seen · 106 lines · 30 tokens per session scan A f6a5ffb6ee68

Subscribe to this mod's changes

documentation-writer is an agent published in the GitHub repository felipeslo/opencode-kit (2 stars, last pushed 5mo ago), licensed MIT. It adds 30 tokens to every session and 588 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. It is 91% identical to documentation-writer, differing in 11 lines, and is treated as a copy.

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