Communitygithub.com

技术文档生成器

为逆向工程、渗透测试、CTF解题等安全分析任务自动生成专业的技术报告和文档。支持多种报告模板和厂商风格。

技术文档生成器 是什么?

该技能专为AI开发者和安全分析人员设计,用于在完成逆向工程、渗透测试、CTF解题或恶意软件分析等任务后,自动生成格式规范、内容完整的技术文档。它支持多种报告类型,包括逆向工程报告、渗透测试报告、CTF Writeup、签名逆向报告以及恶意软件/APT分析报告,并且可以根据任务类型智能选择模板。报告生成遵循严格的Evidence(证据)→ Finding(发现)→ Path(路径)链条,确保每项发现都有据可查、可复现。此外,还支持集成Mermaid图表(如流程图、时序图)以增强报告的可读性和可视化效果。该技能不依赖外部工具,纯文本生成,并可在Claude Code等平台上使用,通过读取`references/`目录下的模板和规则文件来保证输出质量。

兼容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/zhaoxuya520/reverse-skill/tree/main/skills/docs-generator

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

技术文档

ACTION REQUIRED(读完后立刻执行)

  1. NOW:确认当前任务是否命中本 skill 的适用范围
  2. NOW:读取 ../tool-index.md,校验工具可用性和实际路径
  3. NEXT:缺工具时调用 bootstrap,不要猜路径
  4. ACT:进入"工作流"第一步并执行,不要停在确认状态

关于写作风格、语气和语调的指导,请使用 Skill(ce:writer) 并加载 The Engineer 角色。

安全/逆向任务文档输出

当逆向/渗透/CTF/安全分析任务完成后,本 skill 负责在用户项目目录生成正式技术文档。

触发时机

  1. 逆向任务完成,已产出核心结论(算法还原、签名破解、绕过方案等)
  2. 渗透测试完成,已发现并验证漏洞
  3. CTF 题目解出,已拿到 flag
  4. 用户明确要求"写一份报告/文档/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 → 签名逆向报告
恶意软件 / APT / 病毒分析报告references/security-report-templates.md + references/vendor-report-rules.md
通用技术文档references/templates.md → README / API 文档

厂商报告结构(Issue #65)

安全类正式报告 MUST 读取 references/vendor-report-rules.md(只取结构,不抄厂商原文)。仅在任务证据或用户明确要求时选择厂商 flavor;普通逆向和其他任务使用 flavor = null。

Flavor / Overlay何时用主参考骨架
malware明确恶意样本、木马、白加黑、钓鱼投毒火绒式:概述→流程→样本分析→应急处置→IOC
aptAPT/战役/团伙/多阶段感染链/行业定向卡巴斯基 Securelist 式:摘要→感染链→调查叙事→Interesting findings→技术分析→检测缓解→IOC
flavor = null普通 APK/ELF/PE/Mach-O 逆向、算法/固件分析、渗透 / CTF / JS 签名原任务模板 + Base 通用元素;不套 malware/APT 专属章节
thin vuln用户明确要求漏洞/补丁/CVE 技术分析概述→影响/复现→崩溃与补丁分析→防护建议(叠加在 null 上,非第 3 默认全文 flavor)

原则:模板在精不在多 —— 仅 2 个厂商全文 flavor;vuln 仅为可选 thin overlay,不另建第三套默认全文模板。 与 §0 Evidence→Finding→Path 同时生效;冲突时 Evidence 契约优先。

输出规范

  • 输出位置:用户当前项目目录(不是 skill 包目录)
  • 文件名格式:YYYY-MM-DD_[类型]-[目标简称]-report.md
  • 如果项目有 docs/ 目录:优先放在 docs/ 下
  • 编码:UTF-8
  • 语言:跟随用户对话语言(中文对话出中文报告,英文对话出英文报告)

质量要求

  • 所有代码块必须可直接运行或有明确上下文
  • 不要有 placeholder/TODO
  • 关键发现必须有证据支撑
  • 复现步骤必须让第三方能独立重现
  • 敏感信息(真实 token、密码、内部 URL)用占位符替代
  • MUST 包含 Evidence → Finding → Path 链(见 ../ops/evidence-finding-path.md 与模板 §0)
  • MUST 读取 references/vendor-report-rules.md:选定 malware / apt 或 flavor = null(漏洞任务可叠加 thin vuln);无 flavor 时只输出原任务模板和适用的 Base 元素,不强制 IOC/ATT&CK
  • 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 直接渲染。


核心原则

1. 渐进式信息揭露

分层展示信息:

层级内容用户问题
1一句话描述这是什么?
2快速入门代码块如何使用?
3完整 API 参考有哪些选项?
4架构深度解析它是如何工作的?

警告、破坏性变更和前置条件放在最顶部。

2. 面向任务写作

<!-- 差劲:面向特性 -->
## AuthService 类
AuthService 类提供认证方法...

<!-- 好:面向任务 -->
## 用户认证
要认证用户,请调用带有凭据的 login():

3. 展示,而非告知

每个概念都需要一个具体示例。

格式标准

  • 句首大写标题:"Getting started" 而非 "Getting Started"
  • 最多 3 级标题:更深意味着需要拆分文档
  • 代码块始终指定语言
  • 内部链接使用相对路径
  • 结构化数据(3+ 属性)使用表格

质量检查清单

  • 代码示例经过测试且可运行
  • 无占位符文本或 TODO
  • 与实际代码行为一致
  • 无需阅读全文即可扫视理解
  • 读者知道下一步做什么

反模式

问题修复
文字墙使用标题、列表、代码、表格拆分
关键信息被埋没警告/破坏性变更放在顶部
缺少错误文档始终记录可能出错的情况

模板

关于 README、API 端点和文件组织模板,请参见 references/templates.md。

相关技能

  • Skill(ce:writer) - 写作风格、语气和语调(加载 The Engineer 角色)
  • Skill(ce:visualizing-with-mermaid) - 架构图和流程图

按需自举(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/vendor-report-rules.md(flavor: malware | apt | null;optional overlay: vuln) 通用文档模板: references/templates.md

任务完成自检(声称完成前 MUST 通过)

  • 我是否执行了工作流中的每一步(而不是只阅读)?
  • 我是否基于 tool-index 使用了真实工具路径?
  • 我是否产出了可复现证据(命令/脚本/截图/报告)?
  • 报告是否含 Evidence / Finding / Path(ops 契约)?
  • 是否完成并回写了 RULES 要求的 Checklist 项?

Individual skills in this repo

This repo contains 20 individual skills — each has its own dedicated page.

api-security

Use for authorized security assessment of REST, GraphQL, WebSocket, or SOAP APIs, including discovery, authentication, authorization, rate-limit, and CI/CD testing.

apk-reverse

在 CLI 环境下做 Android APK 逆向时使用。适用于 APK 解包、Java 反编译、smali 修改、重打包、Frida 动态 Hook,以及按需切换到 so/native 分析。优先使用本机已安装的 jadx、apktool、frida、adb、ida-reverse、radare2。

attack-chain

Use for authorized multi-stage attack-path planning and orchestration when a task spans reconnaissance, initial access, privilege escalation, lateral movement, or impact assessment. Route single-stage tasks directly to their specialist skill.

binary-diff

|

binary-ninja-reverse

Use for authorized binary analysis in Binary Ninja, including HLIL/MLIL/LLIL inspection, strings/imports/exports, cross-references, types, patch review, Python API automation, and optional Binary Ninja MCP or localhost HTTP integration.

browser-automation

|

browser-extension-reverse

Use for authorized reverse engineering of browser extensions (Chrome/Firefox) including manifest analysis, background workers, and extension-based credential or traffic logic recovery.

case-review

Reviews a reverse-skill case package for scope readiness, Evidence to Finding to Path traceability, work item coverage, timeline references, and optional artifact hash integrity before report handoff.

cloud-k8s

Use for authorized cloud, container, and Kubernetes security assessment including metadata SSRF, IAM misconfig, container escape paths, and cluster RBAC review.

code-audit

Use for authorized source-code security review and SAST workflows including Semgrep, CodeQL patterns, dangerous API hunting, and fix verification.

ctf-sandbox

Thin PRIMARY for CTF / AWD / 靶场 multi-type orchestration. Hands off to the sidecar CTF-Sandbox-Orchestrator. Use when the user says CTF, AWD, 靶场, or 比赛题 and no more specific pwn/APK/IDA route already won.

database-security

Use for authorized database security assessment covering PostgreSQL/MySQL/MSSQL/Mongo/Redis exposure, authz, UDF/command paths, and misconfiguration review.

diagram-generator

generate, refine, validate, and render diagrams from natural language, notes, code snippets, schemas, tables, or existing diagram source. use for flowcharts, swimlanes, sequence diagrams, state diagrams, er diagrams, class diagrams, architecture/c4-style diagrams, dependency graphs, gantt charts, mind maps, user journeys, sankey-style flows, org charts, network graphs, and other visual models. supports mermaid by default, graphviz dot for complex graph layout, plantuml for uml-heavy engineering diagrams, and svg output when direct markup is more reliable.

digital-forensics

Use for authorized digital forensics including memory dumps, disk timelines, PCAP investigation, artifact triage, and IR evidence preservation.

dotnet-reverse

.NET / C# 二进制逆向。当目标是 .NET assembly(PE 头含 CLR、.exe/.dll 托管程序)、C# 编译产物(含 NativeAOT)、红队 Sharp* 工具(Rubeus / SharpHound / SharpHound 等)、.NET 混淆程序(ConfuserEx / SmartAssembly / Babel / Eazfuscator)、.NET loader / info-stealer / 套壳 malware 时使用。优先用 dnSpyEx + de4dot,需要 AI 直接操作时联动 dnSpy MCP。不用于纯 native 二进制(走 reverse-engineering / ida-reverse)。

edr-bypass-re

|

email-security

Use for authorized email security review including phishing analysis, header authentication (SPF/DKIM/DMARC), BEC patterns, and mailbox token abuse research.

firmware-pentest

|

ghidra-reverse

Use for free/open reverse engineering with Ghidra (headless or GUI), including decompile, cross-refs, and optional Ghidra MCP workflows when IDA is unavailable.

go-rust-reverse

Use for reverse engineering stripped Go and Rust binaries including runtime recognition, pclntab/moduel data recovery, panic strings, and idiomatic decompilation recovery.

相关技能