docs-writer

docs-writer is a skill for Claude Code, Codex from sequenzia/agent-alchemy. It costs 42 tokens per session (1,678 once invoked), scanned A, original, MIT.

A documentation tool that reads code analysis findings and turns them into Markdown pages, API references, architecture guides, and change summaries.

In plain words
What is it for?
It helps document software projects for MkDocs sites or GitHub, including practical examples and Mermaid diagrams.
Why use it?
It removes the need to write and structure technical documentation by hand while helping keep it based on the source code.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit It helps document software projects for MkDocs sites or GitHub, including practical examples and Mermaid diagrams.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/sequenzia/agent-alchemy/docs-writer
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.

Any agent
npx skills add sequenzia/agent-alchemy --skill docs-writer
Clone the repo
git clone --depth 1 https://github.com/sequenzia/agent-alchemy

Made for: Claude Code, Codex.

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

README.md
[![agentmods](https://agentmods.dev/badge/skills/sequenzia/agent-alchemy/docs-writer/github.svg)](https://agentmods.dev/skills/sequenzia/agent-alchemy/docs-writer)
Your own site
<a href="https://agentmods.dev/skills/sequenzia/agent-alchemy/docs-writer"><img src="https://agentmods.dev/badge/skills/sequenzia/agent-alchemy/docs-writer/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for docs-writer

Your own site · 80×15
<a href="https://agentmods.dev/skills/sequenzia/agent-alchemy/docs-writer"><img src="https://agentmods.dev/badge/skills/sequenzia/agent-alchemy/docs-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 42 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,678 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00042 $0.01678
Opus 5.5 $0.00017 $0.00671
Sonnet 5.5 $0.00008 $0.00336
Haiku 4.5 $0.00004 $0.00168

Measured 1mo ago against content hash 03b3a1b55459, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

docs-writer scanned grade A with 1 finding 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 1mo 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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

response = requests.get("/api/users")
ported/20260304-102613/dev-tools/skills/docs-writer/SKILL.md · 236 lines

How it starts

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

Documentation Writer

When invoked, perform the following technical documentation tasks: generate high-quality Markdown documentation from codebase analysis findings, in either MkDocs-flavored or standard GitHub-flavored format.

Prerequisites

  • Refer to the technical-diagrams skill (from the core-tools package) for Mermaid diagram styling rules. Use dark text colors on nodes for readability in all generated diagrams.

Mission

Given exploration findings, existing page content, and documentation context:

  1. Generate complete documentation pages or files ready to write to disk
  2. Follow the specified output format conventions (MkDocs or Basic Markdown)
  3. Ensure accuracy by reading source code directly
  4. Produce clear, well-structured content with practical examples

Output Format Modes

Your prompt will specify one of two output formats. Default to MkDocs mode if no format is specified.

MkDocs Mode (Output format: MkDocs)

Use Material for MkDocs extensions and conventions:

  • Admonitions (!!! note, !!! warning, etc.)
  • Tabbed content (=== "Tab Name")
  • Code block titles (```python title="path/to/file.py")
  • Mermaid diagrams (```mermaid)
  • Cross-reference with MkDocs relative paths: [Page](../path/to/page.md)

Basic Markdown Mode (Output format: Basic Markdown)

Standard GitHub-flavored Markdown only — no MkDocs-specific extensions:

  • Replace admonitions with blockquotes: > **Note:** content or > **Warning:** content
  • Replace tabbed content with separate labeled code blocks
  • Mermaid diagrams are still supported (GitHub renders natively)
  • Standard relative links: [File](./path/to/file.md)
  • No code block titles (use a comment or heading above the block instead)

Documentation Types

API Reference

  • Document public functions, classes, methods, and types
  • Include signatures, parameters, return types, and descriptions
  • Provide usage examples for each public API
  • Group by module or logical category

Architecture & Design

  • Explain system structure, component relationships, and data flow
  • Use Mermaid diagrams for visual architecture representation
  • Document design decisions and their rationale
  • Cover integration points and boundaries

Read the full file on GitHub · 236 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. 1mo ago First seen · 236 lines · 42 tokens per session scan A 03b3a1b55459

Subscribe to this mod's changes

docs-writer is a skill published in the GitHub repository sequenzia/agent-alchemy (45 stars, last pushed 4mo ago), licensed MIT. It adds 42 tokens to every session and 1,678 once invoked, about $0.0002 per session on Opus 5.5. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.