docs-generator

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

21|8|Updated Aug 3, 2026
One-click install
npx skills add https://github.com/chengzongcai/reverse-skill-backup --skill docs-generator-chengzongcai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-generator
Source: https://github.com/chengzongcai/reverse-skill-backup/tree/main/skills/docs-generator
Command: npx skills add https://github.com/chengzongcai/reverse-skill-backup --skill docs-generator-chengzongcai

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? After completing reverse engineering, penetration testing, or CTF work, findings often remain scattered in notes and terminal output. This Skill turns completed analysis into formal, reproducible technical reports and general documentation (READMEs, API docs) using structured templates. ## Core Features & Use Cases - Security Report Generation: Produces reverse engineering reports, penetration test reports, CTF writeups, and JS signature analysis reports with mandatory Evidence-Finding-Path chains. - General Documentation: Creates READMEs, API endpoint docs, and architecture documentation following progressive disclosure and task-oriented writing principles. - Diagram Integration: Embeds Mermaid flowcharts and sequence diagrams into reports for call flows, attack paths, and algorithm visualization. - Use Case: After finishing an APK reverse engineering task, ask for a report and receive a dated markdown file in your project directory containing target overview, static/dynamic analysis, core findings, and reproduction steps. ## Quick Start Ask the AI to write a reverse engineering report for the analysis just completed and save it in the current 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 reverse engineering report after analysis?▼

Request a report after the analysis task completes, and the Skill selects the reverse engineering template from its references. It writes a dated markdown file into your project directory with target metadata, static and dynamic analysis, findings, and reproduction steps.

What report templates are available for security tasks?▼

Four security templates exist: reverse engineering report, penetration test report, CTF writeup, and JS/Web signature reverse report. General README and API endpoint templates are also provided in references/templates.md.

Can the generated reports include diagrams?▼

Yes, reports can embed Mermaid flowcharts and sequence diagrams for call flows, attack paths, and algorithm visualization. The diagrams render directly on GitHub and GitLab markdown viewers.

Where are the generated documentation files saved?▼

Files are written to the user's current project directory, not the skill package directory. If a docs/ folder exists, reports go there, using the naming format YYYY-MM-DD_type-target-report.md.

What is the Evidence-Finding-Path requirement in reports?▼

Every security report must include scope summary, at least one evidence entry with reproduction command, findings linked to evidence IDs, and an attack or callflow path. Reports without this chain are considered incomplete.