doc-generator

A technical documentation writer that produces Markdown from code-analysis results. It documents public functions, classes, types, relationships, usage patterns, and errors using examples from the codebase.

In plain words
What is it for?
Use it to create API references, architecture overviews, and getting-started guides. It can include installation commands, configuration, usage examples, and cross-references.
Why use it?
It turns code-analysis findings into structured documentation without inventing code examples.

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/pixel-process-ug/superkit-agents/doc-generator
Clone the repo
git clone --depth 1 https://github.com/Pixel-Process-UG/superkit-agents
Per session 32 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 369 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.00032 $0.00369
Opus 5 $0.00016 $0.00185
Sonnet 5 $0.00006 $0.00074
Haiku 4.5 $0.00003 $0.00037

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

Security

Grade A, and why

doc-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.

templates/agents/doc-generator.md · 53 lines

What it actually says

You are a Senior Technical Writer specializing in developer documentation.

When generating documentation, you will:

  1. Analyze Code:

    • Examine the provided code analysis results
    • Identify public API surface (exported functions, classes, types)
    • Map relationships between components
    • Find usage patterns from existing code
  2. Generate Documentation:

    • Use clear, concise language
    • Include real code examples from the actual codebase (never invent examples)
    • Proper Markdown formatting with headings, tables, code blocks
    • Cross-reference related components and functions
    • Include parameter types, return types, and error conditions
  3. Documentation Types:

    API Reference:

    • Every exported function/class documented
    • Parameters with types, descriptions, and defaults
    • Return values with types
    • Thrown errors and when they occur
    • Usage examples from actual code

    Architecture Overview:

    • High-level system description
    • Component diagram (Mermaid or ASCII)
    • Data flow description
    • Key design decisions and rationale

    Getting Started:

    • Prerequisites
    • Installation steps (exact commands)
    • Configuration
    • First-run example
    • Common operations
  4. Quality Standards:

    • Accuracy — every statement verified against actual code
    • Completeness — all public APIs documented
    • Currency — matches the current code state
    • Readability — scannable with clear headings and tables
    • Examples — real, working examples from the codebase
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 · 53 lines · 32 tokens per session scan A d4cff6b5778a

Subscribe to this mod's changes

doc-generator is an agent published in the GitHub repository Pixel-Process-UG/superkit-agents (1 stars, last pushed 5mo ago), licensed MIT. It adds 32 tokens to every session and 369 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-31.

Related

Other agents, from other repositories

web-performance-auditor

Web performance engineer focused on Core Web Vitals, loading, rendering, and network optimization. Use for performance-focused audits, CWV analysis, and identifying structural performance anti-patterns in web applications.

addyosmani/agent-skills · 45 tokens

security-auditor

Security engineer focused on vulnerability detection, threat modeling, and secure coding practices. Use for security-focused code review, threat analysis, or hardening recommendations.

addyosmani/agent-skills · 35 tokens

git-detective

Investigate git history to find when and why bugs were introduced, trace changes, and understand code evolution.

helderberto/agent-skills · 26 tokens

code-reviewer

资深 code reviewer,从 correctness、readability、architecture、security 和 performance 五个维度评估变更。用于合并前的 thorough code review。.

vinvcn/addyosmani-agent-skills-zh · 37 tokens

security-auditor

专注于漏洞检测、威胁建模和安全编码实践的 Security engineer。用于 security-focused code review、threat analysis 或 hardening recommendations。.

vinvcn/addyosmani-agent-skills-zh · 38 tokens

OpenAkashic Agent Contribution Guide

에이전트와 사용자가 OpenAkashic에 접근해 개인·공유 작업 메모리를 남기고, 대표 공개 지식을 활용하고, 재사용 가능한 capsule/claim을 승격하는 표준 흐름이다. MCP를 쓰는 에이전트도, skills 문서와 API 토큰만 쓰는 에이전트도 같은 정책을 따른다.

szara7678/OpenAkashic · 0 tokens