docs-generator

A workflow for producing task-focused technical documentation, such as README files, API guides, architecture notes, and reports of security or reverse-engineering work.

In plain words
What is it for?
Writing project documentation, API documentation, architecture documents, CTF write-ups, reverse-engineering reports, and penetration-test reports.
Why use it?
It turns completed technical work into structured documents with evidence, reproducible steps, and details suited to the task.

Skill for Claude CodeCodex

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 skills/2233admin/reverse-skill-evolver/docs-generator
Any agent
npx skills add 2233admin/reverse-skill-evolver --skill docs-generator
Clone the repo
git clone --depth 1 https://github.com/2233admin/reverse-skill-evolver

Made for: Claude Code, Codex.

Per session 88 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,427 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 83% 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.00088 $0.01427
Opus 5 $0.00044 $0.00714
Sonnet 5 $0.00018 $0.00285
Haiku 4.5 $0.00009 $0.00143

Measured 2d ago against content hash 642c9d96108e, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

docs-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 2d 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.

Origin

This is a copy

83% identical to docs-generator — 35 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.

skills/docs-generator/SKILL.md · 157 lines

How it starts

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

Technical Documentation

For writing style, tone, and voice guidance, use Skill(ce:writer) with The Engineer persona.

安全/逆向任务文档输出

当逆向/渗透/CTF/安全分析任务完成后,本 skill 负责在用户项目目录生成正式技术文档。

触发时机

  1. 逆向任务完成,已产出核心结论(算法还原、签名破解、绕过方案等)
  2. 渗透测试完成,已发现并验证漏洞
  3. CTF 题目解出,已拿到 flag
  4. 用户明确要求"写一份报告/文档/writeup"

模板选择

任务类型 使用模板
APK/二进制/so 逆向 references/security-report-templates.md → 逆向工程报告
渗透测试/漏洞挖掘 references/security-report-templates.md → 渗透测试报告
CTF 解题 references/security-report-templates.md → CTF Writeup
JS/Web 签名逆向 references/security-report-templates.md → 签名逆向报告
通用技术文档 references/templates.md → README / API 文档

输出规范

  • 输出位置:用户当前项目目录(不是 skill 包目录)
  • 文件名格式YYYY-MM-DD_[类型]-[目标简称]-report.md
  • 如果项目有 docs/ 目录:优先放在 docs/
  • 编码:UTF-8
  • 语言:跟随用户对话语言(中文对话出中文报告,英文对话出英文报告)

质量要求

  • 所有代码块必须可直接运行或有明确上下文
  • 不要有 placeholder/TODO
  • 关键发现必须有证据支撑
  • 复现步骤必须让第三方能独立重现
  • 敏感信息(真实 token、密码、内部 URL)用占位符替代

图表集成

生成报告时,应在适当位置调用 diagram-generator skill 生成可视化图表:

报告类型 建议图表 图表类型
逆向工程报告 函数调用关系图、数据流图 Mermaid flowchart / sequenceDiagram
渗透测试报告 攻击路径图、网络拓扑图 Mermaid flowchart / Graphviz
CTF Writeup 解题思路流程图 Mermaid flowchart
JS 签名逆向报告 请求链路时序图、算法流程图 Mermaid sequenceDiagram / flowchart

图表以 Mermaid 代码块形式嵌入报告 markdown 中,确保可在 GitHub/GitLab 直接渲染。


Core Principles

1. Progressive Disclosure

Reveal information in layers:

Layer Content User Question
1 One-sentence description What is it?
2 Quick start code block How do I use it?
3 Full API reference What are my options?
4 Architecture deep dive How does it work?

Warnings, breaking changes, and prerequisites go at the TOP.

2. Task-Oriented Writing

<!-- Bad: Feature-oriented -->
## AuthService Class
The AuthService class provides authentication methods...

<!-- Good: Task-oriented -->
## Authenticating Users
To authenticate a user, call login() with credentials:

Read the full file on GitHub · 157 lines

Files

What ships with it

2 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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. 2d ago First seen · 157 lines · 88 tokens per session scan A 642c9d96108e

Subscribe to this mod's changes

docs-generator is a skill published in the GitHub repository 2233admin/reverse-skill-evolver (13 stars, last pushed 21d ago), licensed MIT. It adds 88 tokens to every session and 1,427 once invoked, about $0.0004 per session on Opus 5. A static security scan graded it A with 0 findings. It is 83% identical to docs-generator, differing in 35 lines, and is treated as a copy.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens

babysit-pr

Babysit a GitHub pull request after creation by continuously polling review comments, CI checks/workflow runs, and mergeability state until the PR is merged/closed or user help is required. Diagnose failures, retry likely flaky failures up to 3 times, auto-fix/push branch-related issues when appropriate, and keep…

openai/codex · 114 tokens

imagegen

Generate or edit raster images when the task benefits from AI-created bitmap visuals such as photos, illustrations, textures, sprites, mockups, or transparent-background cutouts. Use when Codex should create a brand-new image, transform an existing image, or derive visual variants from references, and the output…

openai/codex · 113 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens

next-cache-components-optimizer

Drive a Next.js route to instant navigation by setting up an agentic loop, under Cache Components / PPR, on initial load (hard navigation) and client-side navigation (soft navigation). Encode the goal as a failing @next/playwright instant() e2e and work it to green, one verified route at a time; the shipped test then…

vercel/next.js · 170 tokens