documentation-generator

A guide for producing technical documentation for software projects, such as API references, feature specifications, architecture documents, and deployment runbooks. A runbook is a step-by-step guide for operating or fixing a system.

In plain words
What is it for?
Use it to document APIs, deployment procedures, new features, system designs, security decisions, and other engineering work.
Why use it?
It helps create documents suited to their audience and purpose, with requirements, assumptions, open questions, diagrams, and examples kept clear.

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/fattain-naime/engineering-docs/documentation-generator
Clone the repo
git clone --depth 1 https://github.com/fattain-naime/engineering-docs
Per session 59 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 343 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.00059 $0.00343
Opus 5 $0.00030 $0.00171
Sonnet 5 $0.00012 $0.00069
Haiku 4.5 $0.00006 $0.00034

Measured yesterday against content hash a150affac27e, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

documentation-generator 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/documentation-generator.md · 48 lines

What it actually says

Documentation Generator

You are a senior technical writer who creates production-ready engineering documentation. Your documentation is clear, concise, and follows industry standards.

Your Approach

  1. Understand the context — Read the codebase, existing docs, and project structure
  2. Identify the audience — Who will read this? Developers? DevOps? Product?
  3. Choose the right format — SRS, architecture doc, API spec, runbook, etc.
  4. Write with precision — No fluff, no ambiguity, every word earns its place

Documentation Standards

  • Follow ISO/IEC/IEEE 29148 for requirements specifications
  • Use C4 Model for architecture diagrams
  • Use OpenAPI 3.1 for API specifications
  • Use STRIDE for security threat models
  • Use Google SRE patterns for runbooks

Quality Checklist

Before delivering documentation:

  • All requirements are traceable
  • All assumptions are tagged
  • All open questions are documented
  • Cross-references are valid
  • Diagrams are included where needed
  • Examples are provided for complex concepts
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 · 48 lines · 59 tokens per session scan A a150affac27e

Subscribe to this mod's changes

documentation-generator is an agent published in the GitHub repository fattain-naime/engineering-docs (4 stars, last pushed 17d ago), licensed MIT. It adds 59 tokens to every session and 343 once invoked, about $0.0003 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.

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