docs-generator

Generates task-oriented technical documentation and security analysis reports from templates.

7|4|Updated Jun 22, 2026
One-click install
npx skills add https://github.com/dbx0/skills --skill docs-generator-dbx0
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-generator
Source: https://github.com/dbx0/skills/tree/main/skills/_tooling/docs-generator
Command: npx skills add https://github.com/dbx0/skills --skill docs-generator-dbx0

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Writing consistent, high-quality technical documentation and formal security reports after completing reverse engineering, penetration testing, or CTF tasks is time-consuming and often skipped. This Skill automates the production of structured, evidence-backed reports and general documentation using proven templates. ## Core Features & Use Cases - Security Report Generation: Produces formal reports for reverse engineering, penetration testing, CTF writeups, and JS signature reversing using dedicated templates in references/security-report-templates.md. - General Documentation: Creates READMEs, API endpoint docs, and architecture documentation following progressive disclosure and task-oriented writing principles. - Diagram Integration: Embeds Mermaid diagrams (flowcharts, sequence diagrams) into reports by coordinating with a diagram-generator skill. - Use Case: After finishing an APK reverse engineering task, automatically generate a dated report file in the project directory with target overview, static/dynamic analysis findings, reproduction steps, and an embedded call-graph diagram. ## Quick Start Ask the assistant to write a penetration test report for the vulnerability you just verified, and it will produce a formatted markdown report in your project directory.

Frequently Asked Questions about docs-generator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a penetration test report automatically?

Ask the assistant to write a report after a vulnerability is verified. The skill selects the Penetration Test Report template from references/security-report-templates.md and outputs a dated markdown file with findings, evidence, reproduction steps, and remediation advice.

How to write a CTF writeup with a standard structure?

Use the CTF Writeup template, which includes challenge description, step-by-step solution approach, key exploit code, the flag, pitfall notes, and knowledge points. The skill triggers automatically once a challenge is solved and the flag is obtained.

What report templates are included for reverse engineering?

Four security templates are provided: Reverse Engineering Report, Penetration Test Report, CTF Writeup, and JS/Web Signature Reversing Report. General README and API endpoint templates live in references/templates.md.

Can the generated reports include architecture or flow diagrams?

Yes. The skill calls a diagram-generator skill to embed Mermaid flowcharts and sequence diagrams directly in the markdown, so they render on GitHub and GitLab without external tooling.

Where are the generated documentation files saved?

Reports are written to the user's current project directory, preferably under a docs/ folder if one exists. Filenames follow the format YYYY-MM-DD_[type]-[target]-report.md in UTF-8 encoding.

Does the documentation skill require external tools or dependencies?

No. It is pure text generation with no bootstrap or external dependencies. Diagram rendering is optional and delegated to a separate diagram-generator skill when visuals are needed.