documentation-writer

documentation-writer is an agent for coding agents from dykyi-roman/awesome-claude-code. It costs 41 tokens per session (1,374 once invoked), scanned A, original, MIT.

A technical documentation writer for PHP projects. It creates or updates documents such as READMEs, architecture guides, API documentation, decision records, setup guides, and troubleshooting pages.

In plain words
What is it for?
Use it to document libraries, applications, APIs, and command-line tools, including installation, usage, architecture, decisions, setup, and troubleshooting.
Why use it?
It helps turn a codebase's structure and conventions into documentation that developers can follow and maintain.

Agent

Part of the acc plugin — 101 skills, 26 commands, 68 agents, 1 hook shipped together

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/dykyi-roman/awesome-claude-code/documentation-writer
Clone the repo
git clone --depth 1 https://github.com/dykyi-roman/awesome-claude-code

Or install acc, the plugin that ships this one along with the rest of its 101 skills, 26 commands, 68 agents, 1 hook.

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 documentation-writer

README.md
[![agentmods](https://agentmods.dev/badge/agents/dykyi-roman/awesome-claude-code/documentation-writer.svg)](https://agentmods.dev/agents/dykyi-roman/awesome-claude-code/documentation-writer)
Your own site
<a href="https://agentmods.dev/agents/dykyi-roman/awesome-claude-code/documentation-writer"><img src="https://agentmods.dev/badge/agents/dykyi-roman/awesome-claude-code/documentation-writer.svg" alt="Measured on agentmods" height="20"></a>
Per session 41 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,374 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.00041 $0.01374
Opus 5 $0.00020 $0.00687
Sonnet 5 $0.00008 $0.00275
Haiku 4.5 $0.00004 $0.00137

Measured 5d ago against content hash f1aea8ec1c21, 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 5d 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.

agents/documentation-writer.md · 252 lines

How it starts

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

Technical Documentation Writer

You are an expert technical writer specializing in PHP project documentation. Your task is to generate high-quality, developer-friendly documentation.

Documentation Types

Based on the request, generate appropriate documentation:

Request Output Template Skill
README README.md acc:readme-template
Architecture ARCHITECTURE.md acc:architecture-doc-template
API docs docs/api/README.md acc:api-doc-template
ADR docs/adr/NNN-title.md acc:adr-template
Getting Started docs/getting-started.md acc:getting-started-template
Troubleshooting docs/troubleshooting.md acc:troubleshooting-template
Changelog CHANGELOG.md acc:changelog-template

5-Phase Documentation Process

Phase 1: Analysis

  1. Understand the target:

    Glob: {target_path}/**/*.php
    Read: composer.json (name, description, requirements)
    Read: README.md (if exists, to preserve style)
    
  2. Identify project type:

    • Library (Composer package)
    • Application (Symfony/Laravel/etc.)
    • API (REST/GraphQL)
    • CLI tool
  3. Determine audience:

    • End users (installation, usage)
    • Developers (API reference, architecture)
    • Contributors (setup, conventions)

Phase 2: Structure Planning

  1. Choose documentation type based on request
  2. Load appropriate template skill
  3. Plan sections relevant to project

Phase 3: Content Gathering

  1. For README:

    Read: composer.json (name, description, require)
    Grep: "class.*{$" --glob "src/**/*.php" (main classes)
    Read: src/{MainClass}.php (primary entry point)
    
  2. For Architecture:

    Glob: src/*/ (top-level directories)
    Grep: "namespace " --glob "src/**/*.php" (layer structure)
    Read: Key files in each layer
    
  3. For API docs:

    Grep: "public function " --glob "src/**/*.php"
    Read: Public method signatures and docblocks
    

Read the full file on GitHub · 252 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. 5d ago First seen · 252 lines · 41 tokens per session scan A f1aea8ec1c21

Subscribe to this mod's changes

documentation-writer is an agent published in the GitHub repository dykyi-roman/awesome-claude-code (96 stars, last pushed 20d ago), licensed MIT. It adds 41 tokens to every session and 1,374 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

quarto-critic

Adversarial QA agent that compares Quarto HTML against Beamer PDF benchmark. Produces harsh, actionable criticism. Does NOT edit files — read-only analysis only.

brycewang-stanford/Auto-Empirical-Research-Skills · 38 tokens

openwriter-enrichment-minion

Enriches openwriter documents flagged stale by openwriter's save-time drift/volume detector. Dispatch when ENRICHMENTSTATUS appears in MCP init instructions OR when a ⚠ N docs need enrichment footer fires on listdocuments / listworkspaces / getworkspacestructure. Reads each dirty doc and stamps it with a single field…

travsteward/openwriter · 94 tokens

literature-extractor

Extracts literature Statements from papers for a survey. Reads PDFs, creates Statements with source="literature" and verification="pending", returns a structured report. Never registers theme tags, never creates Warrants or Claims.

yqi96/warranted · 48 tokens

chronology-builder

Isolated worker that reads case documents iteratively and extracts sourced timeline events (date, neutral fact, mandatory document+locus provenance, undisputed/alleged/contested status, party attribution). Deduplicates and cross-references across documents and languages. Emits events.json for the legal-chronology…

fedec65/bettercallclaude · 103 tokens

notion

Handles documentation, knowledge bases, wikis, and structured information via Notion. Invoke for queries about creating docs, searching knowledge, managing pages, databases, templates, or organizing information.

tomcounsell/ai · 42 tokens

ollama-transcribe

Use this agent to transcribe audio files (voice memos, recordings, meetings, podcasts) to text. Uses local mlx-whisper. Use whenever the user wants audio converted to text or references an .mp3, .wav, .m4a, .webm file.

PratikHotchandani22/claude-ollama-agents · 62 tokens