Communitygithub.com

文檔生成器

在安全/逆向工程任務完成後,自動產出結構化技術文檔(報告、writeup、README)。支援 APK 逆向、滲透測試、CTF 解題、惡意軟體分析等多種任務類型。

文檔生成器 是什麼?

本技能(docs-generator)負責在安全/逆向工程任務完成後,自動化生成結構嚴謹的技術文檔。其設計重點在於「證據→發現→路徑」的完整鏈結,確保每一份文檔都具有可復現性與第三方驗證能力。 技能適用於多種任務:APK/二進位逆向、滲透測試、CTF 解題、JS/Web 簽名逆向,以及惡意軟體/APT 分析。針對不同任務,技能會自動選用對應的報告模板(參考 references/security-report-templates.md),並支援兩種廠商風味(malware、apt)以及可選的漏洞分析薄層(thin vuln)疊加。 技能導入了圖表整合機制(diagram-generator skill),可根據報告類型(逆向工程、滲透測試、CTF writeup)自動建議並嵌入 Mermaid 圖表,從而提升文檔的可讀性。輸出位置固定為使用者目前專案目錄,檔案命名格式為 YYYY-MM-DD_類型-目標簡稱-report.md,並優先放置於 docs/ 目錄下。 此技能可與多個上游安全技能(apk-reverse、ida-reverse、js-reverse 等)自動串接,也能由使用者手動觸發(如「寫報告」)。整個生成流程遵循漸進式揭露(Progressive Disclosure)原則,將關鍵警告與破壞性變更置於文件頂部,並保持以任務為導向的寫作風格,而非以類別/功能為中心。

相容平台~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
  • 語言:跟隨使用者對話語言(中文對話出中文報告,英文對話出英文報告)

品質要求

  • 所有程式碼區塊必須可直接執行或有明確上下文
  • 不要有佔位符/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.

相關技能