Documentation Generator
FreeAutomate technical documentation for clarity and compliance.
Free · Opens the source repo
What Documentation Generator does
The Documentation Generator skill is designed to streamline the creation of task-oriented technical documentation, particularly useful for developers and security analysts. This skill is ideal for generating various types of documentation such as READMEs, API documentation, architecture documents, and formal reports following security analysis tasks. By leveraging progressive disclosure, it ensures that essential information is presented in a structured manner, making it easier for users to understand and utilize the content effectively.
When you complete tasks related to reverse engineering, penetration testing, or Capture The Flag (CTF) challenges, this skill can automatically generate a formal report in your project directory. It provides templates tailored for different task types, ensuring that your documentation is not only comprehensive but also adheres to industry standards. The skill outputs documentation in Markdown format, enabling easy integration into existing projects and workflows.
The skill emphasizes quality and usability by ensuring that all code examples are runnable, avoiding placeholder text, and requiring that critical findings are supported by evidence. Additionally, it includes a mechanism for generating visual diagrams using the Mermaid syntax, allowing for enhanced clarity in reports. This is particularly beneficial for users who need to present their findings in a professional format, making it suitable for both internal documentation and external audits.
Whether you are a developer needing to document your code or a security professional preparing a report after a thorough analysis, the Documentation Generator skill provides a reliable solution to automate and enhance your documentation processes, saving you time and ensuring accuracy in your reports.
When to use it
Use this skill when you need to generate documentation after completing technical tasks such as reverse engineering or security testing.
When not to use it
This skill is not suitable for tasks that require extensive customization beyond the provided templates or for documentation unrelated to technical tasks.
What you can build with it
Generating API Documentation
After developing a new API, use this skill to create comprehensive documentation that outlines endpoints, request/response formats, and usage examples.
Creating Security Analysis Reports
Upon completing a penetration test, generate a detailed report that documents findings, methodologies, and evidence to support your conclusions.
Documenting Reverse Engineering Findings
After analyzing a binary or APK, use the skill to compile your findings into a structured report that can be shared with your team or stakeholders.
How to install Documentation Generator
View source1. Install with the skills CLI
npx skills add zhaoxuya520/reverse-skill/docs-generator --agent claude-code2. Or install it manually
Download the skill folder and drop it into ~/.claude/skills/ for all projects, or .claude/skills/ to scope it to one repo. Restart Claude Code so it picks up the new skill.
Anthropic's agentic coding CLI, and the reference implementation of Agent Skills. Drop a skill folder into ~/.claude/skills and Claude Code loads it automatically whenever a task matches the skill's description. Claude Code docs
Inside SKILL.md
Written by zhaoxuya520Technical Documentation
ACTION REQUIRED（读完后立刻执行）
NOW：确认当前任务是否命中本 skill 的适用范围NOW：读取../tool-index.md，校验工具可用性和实际路径NEXT：缺工具时调用 bootstrap，不要猜路径ACT：进入"工作流"第一步并执行，不要停在确认状态
For writing style, tone, and voice guidance, use Skill(ce:writer) with The Engineer persona.
安全/逆向任务文档输出
当逆向/渗透/CTF/安全分析任务完成后，本 skill 负责在用户项目目录生成正式技术文档。
触发时机
- 逆向任务完成，已产出核心结论（算法还原、签名破解、绕过方案等）
- 渗透测试完成，已发现并验证漏洞
- CTF 题目解出，已拿到 flag
- 用户明确要求"写一份报告/文档/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? |
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:
3. Show, Don't Tell
Every concept needs a concrete example.
Formatting Standards
- Sentence case headings: "Getting started" not "Getting Started"
- Max 3 heading levels: Deeper means split the doc
- Always specify language in code blocks
- Relative paths for internal links
- Tables for structured data with 3+ attributes
Quality Checklist
- Code examples tested and runnable
- No placeholder text or TODOs
- Matches actual code behavior
- Scannable without reading everything
- Reader knows what to do next
Anti-Patterns
| Problem | Fix |
|---|---|
| Wall of text | Break up with headings, bullets, code, tables |
| Buried critical info | Warnings/breaking changes at TOP |
| Missing error docs | Always document what can go wrong |
Templates
For README, API endpoint, and file organization templates, see references/templates.md.
Related Skills
Skill(ce:writer)- Writing style, tone, and voice (load The Engineer persona)Skill(ce:visualizing-with-mermaid)- Architecture and flow diagrams
按需自举（On-Demand Bootstrap）
本 skill 不依赖外部工具，纯文本生成。无需 bootstrap。
如果需要渲染图表嵌入报告，会调用 diagram-generator/ skill。
路由上下文
上游入口: 所有安全/逆向 skill 在任务完成后自动调用本 skill 触发方式:
- 自动：任务完成后作为行为链第 9 步执行
- 手动：用户说"写报告"、"出文档"、"writeup"
同级关联模块:
apk-reverse/— APK 逆向完成后生成逆向报告ida-reverse/— 二进制分析完成后生成逆向报告radare2/— CLI 分析完成后生成逆向报告js-reverse/— JS 签名逆向完成后生成签名报告reverse-engineering/— 通用逆向完成后生成逆向报告field-journal/— 报告内容同时作为进化日志的数据来源
安全报告模板: references/security-report-templates.md
通用文档模板: references/templates.md
任务完成自检（声称完成前 MUST 通过）
- 我是否执行了工作流中的每一步（而不是只阅读）？
- 我是否基于
tool-index使用了真实工具路径？ - 我是否产出了可复现证据（命令/脚本/截图/报告）？
- 报告是否含 Evidence / Finding / Path（ops 契约）？
- 是否完成并回写了 RULES 要求的 Checklist 项？
Frequently asked questions about Documentation Generator
Similar skills
Supabase Docs Authoring
Streamline your Supabase documentation process.
Docs Writer
Streamline your documentation process with precision.
Clinical Case Report
Generate structured medical case presentations.
CrossFrame Suite
Streamline complex workflows for Chinese structural analysis.
Em Dash Expert
Master the em dash for clear, precise writing.
Nature Statistics Reporting
Enhance manuscript statistics for high-impact journal submissions.