docs-generator

A guide for writing technical documentation such as README files, API references, architecture explanations, and Markdown reports.

In plain words
What is it for?
Use it when documenting software, recording architecture decisions, writing API documentation, or producing reports after security analysis, reverse engineering, penetration testing, or CTF work.
Why use it?
It turns completed technical work into organized documentation that readers can understand progressively, from an overview to deeper details.

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/xamirhamza77/reverseops-skill/docs-generator
Any agent
npx skills add xAmirHamza77/ReverseOps-Skill --skill docs-generator
Clone the repo
git clone --depth 1 https://github.com/xAmirHamza77/ReverseOps-Skill

Made for: Claude Code, Codex.

Per session 90 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,597 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.00090 $0.01597
Opus 5 $0.00045 $0.00798
Sonnet 5 $0.00018 $0.00319
Haiku 4.5 $0.00009 $0.00160

Measured 2d ago against content hash 31078033acf9, 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.

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 (execute immediately after reading)

  1. NOW: Confirm whether the current task falls within this skill's scope
  2. NOW: Read ../tool-index.md to verify tool availability and actual paths
  3. NEXT: If a tool is missing, invoke bootstrap — do not guess paths
  4. ACT: Enter the first step of the "Workflow" and execute — do not stop at the confirmation stage

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

Security / Reverse Engineering Task Documentation Output

After a reverse engineering / penetration testing / CTF / security analysis task is completed, this skill is responsible for generating formal technical documentation in the user's project directory.

Trigger timing

  1. A reverse engineering task is complete and core conclusions have been produced (algorithm recovery, signature cracking, bypass solution, etc.)
  2. A penetration test is complete and vulnerabilities have been discovered and verified
  3. A CTF challenge is solved and the flag has been captured
  4. The user explicitly asks to "write a report/document/writeup"

Template selection

Task type Template to use
APK/binary/so reverse engineering references/security-report-templates.md → Reverse Engineering Report
Penetration testing / vulnerability discovery references/security-report-templates.md → Penetration Test Report
CTF solve references/security-report-templates.md → CTF Writeup
JS/Web signature reverse engineering references/security-report-templates.md → Signature Reverse Engineering Report
General technical documentation references/templates.md → README / API docs

Output conventions

  • Output location: the user's current project directory (not the skill package directory)
  • Filename format: YYYY-MM-DD_[type]-[target-short-name]-report.md
  • If the project has a docs/ directory: prefer placing the report under docs/
  • Encoding: UTF-8
  • Language: follow the language of the user's conversation (Chinese conversation → Chinese report, English conversation → English report)

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 · 90 tokens per session scan A 31078033acf9

Subscribe to this mod's changes

docs-generator is a skill published in the GitHub repository xAmirHamza77/ReverseOps-Skill (4 stars, last pushed 1mo ago), licensed MIT. It adds 90 tokens to every session and 1,597 once invoked, about $0.0005 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.