docs-generator

A documentation-writing helper for producing task-focused technical documents such as READMEs, API references, architecture notes, and security reports.

In plain words
What is it for?
It helps write project documentation and formal reports for reverse engineering, penetration testing, capture-the-flag challenges, and security analysis.
Why use it?
It gives developers a structured way to explain how software works and how findings can be reproduced, instead of leaving documentation incomplete or hard to follow.

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

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,692 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 89% 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.01692
Opus 5 $0.00044 $0.00846
Sonnet 5 $0.00018 $0.00338
Haiku 4.5 $0.00009 $0.00169

Measured 2d ago against content hash 4fe8291f6427, 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

89% identical to docs-generator — 17 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 · 175 lines

How it starts

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

Technical Documentation

ACTION REQUIRED(读完后立刻执行)

  1. NOW:确认当前任务是否命中本 skill 的适用范围
  2. NOW:读取 ../tool-index.md,校验工具可用性和实际路径
  3. NEXT:缺工具时调用 bootstrap,不要猜路径
  4. ACT:进入"工作流"第一步并执行,不要停在确认状态

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)用占位符替代
  • MUST 包含 Evidence → Finding → Path 链(见 ../ops/evidence-finding-path.md 与模板 §0)
  • SHOULD 引用 case scope.md / timeline.md../scripts/case-init.ps1

图表集成

生成报告时,应在适当位置调用 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?

Read the full file on GitHub · 175 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 · 175 lines · 88 tokens per session scan A 4fe8291f6427

Subscribe to this mod's changes

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