docs-generator
Creates task-oriented technical documentation with progressive disclosure. Use when writing READMEs, API docs, architecture docs, or markdown documentation. Also use this skill at the END of any completed reverse engineering, penetration testing, CTF, or security analysis task to generate a formal report in the user's project directory. Trigger keywords: 写报告, 写文档, 出报告, writeup, 技术文档, report, documentation.
- License 许可
- MIT
- 最近更新
- 2026-10-15
- Stars
- ★ 42
- Forks
- 24
01 前言 Front Matter
- name
- docs-generator
- description
- Creates task-oriented technical documentation with progressive disclosure. Use when writing READMEs, API docs, architecture docs, or markdown documentation. Also use this skill at the END of any completed reverse engineering, penetration testing, CTF, or security analysis task to generate a formal report in the user's project directory. Trigger keywords: 写报告, 写文档, 出报告, writeup, 技术文档, report, documentation.
02 资源文件 2
- 参考文档references/security-report-templates.md4.9 KB
- 参考文档references/templates.md1.9 KB
03 SKILL.md 正文
Technical Documentation
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)用占位符替代
图表集成
生成报告时,应在适当位置调用 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
04 同仓库更多 Skills
yingan-tuoxiu
Owner-authorized YingAn/YingPo Android APK shell rehydration and stable rebuild workflow. Use for APKs with tiny or abnormal root DEX files, v.m.p or abcd655xx shell callbacks, libabcd/lib*shellservice_dex native loaders, protected assets, runtime-loaded DEX images, hidden real Application or Activity routes, and native lifecycle wrappers that must be recovered into a normally installable, signed multidex APK without changing product authentication or business authorization behavior.
reverse-engineering
Use when performing reverse engineering on any target: websites, desktop binaries (PE/ELF), mobile apps (APK/IPA), or network protocols. Covers web scraping/API reverse, disassembly and decompilation, Frida/Xposed hooking, il2cpp/Unity reverse, protocol capture and replay, encryption/signature analysis, and memory debugging. Triggers: 逆向、反编译、Hook、脱壳、抓包、协议分析、Frida、Xposed、il2cpp、Unity逆向、 内存扫描、DLL注入、PE分析、ELF分析、APK逆向、IPA逆向、反混淆、签名分析、加密还原、 smali、Ghidra、IDA、Cheat Engine、mitmproxy、Wireshark、脱壳、加固、SO逆向、Web逆向。
game-hacking
游戏辅助开发全链路助手——覆盖内存读写、协议分析、反编译、Hook 技术、驱动级隐藏、自动化脚本。 支持 C/C++、Python、x86/x64 汇编、DirectX/OpenGL。适用于 PC 端游、Android/iOS 手游、主机游戏。 当用户提到以下任何关键词时必须触发:游戏外挂、游戏辅助、内存修改、CE教程、游戏Hook、 协议分析、反编译、驱动隐藏、游戏脚本、按键精灵、游戏逆向、内存扫描、指针追踪、DLL注入、 游戏破解、脱壳、抓包分析、Frida、Xposed、il2cpp、Unity逆向、UE4逆向、DirectX Hook、 OpenGL Hook、游戏自动化、坐标识别、模板匹配、游戏安全测试。
supply-chain-security
暂无简介
reverse-engineering
Provides reverse engineering techniques. Use when the main job is to understand how a compiled, obfuscated, packed, or virtualized target works before exploiting or solving it, including binaries, APKs, WASM, firmware, custom VMs, bytecode, malware-like loaders, and anti-debug or anti-analysis logic. Do not use it when the vulnerability is already understood and the remaining task is exploitation; use pwn instead. Do not use it for pure web workflows, log or disk forensics, or standalone crypto problems unless reversing the implementation is the real blocker.
radare2
Use this skill whenever the user wants to analyze binaries with radare2/r2 from the command line, including reverse engineering, disassembly, function analysis, strings/import inspection, patching, binary diffing, hex inspection, or r2 scripting. Also use it when the user mentions PE/ELF/Mach-O/DEX/WASM files together with CLI analysis, `rabin2`, `rasm2`, `radiff2`, `r2pipe`, or asks for radare2 command help on Windows/Linux/macOS.