docs-generator skill
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.
Is the docs-generator skill safe?
Clean: nothing in its files matched our rules. We read 4 files in the folder on 2026-09-28.
No findings.
Install the docs-generator skill
A skill is a folder. Copy it into your agent's skills folder and the agent loads it when the task matches its description.
git clone --depth 1 https://github.com/zhaoxuya520/reverse-skill.git /tmp/reverse-skill mkdir -p ~/.claude/skills cp -r /tmp/reverse-skill/skills/docs-generator ~/.claude/skills/docs-generator
In the Claude apps, zip the folder and upload it from the Skills settings. The folder on GitHub
The instructions your agent would load
SKILL.md as published, without the frontmatter. Read it on GitHub
Technical 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"
模板选择
厂商报告结构(Issue #65)
安全类正式报告 MUST 读取 references/vendor-report-rules.md(只取结构,不抄厂商原文)。仅在任务证据或用户明确要求时选择厂商 flavor;普通逆向和其他任务使用 flavor = null。
原则:模板在精不在多 —— 仅 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 代码块形式嵌入报告 markdown 中,确保可在 GitHub/GitLab 直接渲染。
Core Principles
1. Progressive Disclosure
Reveal information in layers:
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
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/vendor-report-rules.md(flavor: malware | apt | null;optional overlay: vuln) 通用文档模板: references/templates.md
任务完成自检(声称完成前 MUST 通过)
- [ ] 我是否执行了工作流中的每一步(而不是只阅读)?
- [ ] 我是否基于 tool-index 使用了真实工具路径?
- [ ] 我是否产出了可复现证据(命令/脚本/截图/报告)?
- [ ] 报告是否含 Evidence / Finding / Path(ops 契约)?
- [ ] 是否完成并回写了 RULES 要求的 Checklist 项?
More skills from zhaoxuya520/reverse-skill
- Fapi-securityUse for authorized security assessment of REST, GraphQL, WebSocket, or SOAP APIs, including discovery, authentication, authorization, rate-limit, and CI/CD testing.
- Capk-reverse在 CLI 环境下做 Android APK 逆向时使用。适用于 APK 解包、Java 反编译、smali 修改、重打包、Frida 动态 Hook,以及按需切换到 so/native 分析。优先使用本机已安装的 jadx、apktool、frida、adb、ida-reverse、radare2。
- Cattack-chainUse 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.
- Abinary-diff跨版本符号迁移与二进制差分。当你有旧版本的符号/逆向结果,需要快速迁移到新版本时使用。 适用场景:内核缺 PDB 用旧版符号推导、程序更新后批量迁移函数名、应用更新后快速定位新偏移。 核心方法:用 LLM 做结构化差异比对,程序化输入输出,成本极低(200 函数 ~1 元)。 触发关键词:符号迁移、bindiff、跨版本、PDB 缺失、函数偏移迁移、symbol migration、binary diff、版本对比。
- Abinary-ninja-reverseUse 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.
- Abrowser-automation统一自动化入口。覆盖浏览器自动化(Playwright)和 Windows 桌面应用自动化(OpenReverse)。 浏览器场景:打开网页、点击、填表、爬取、截图、自动化登录、渗透页面交互。 桌面场景:操作 IDA/x64dbg 等 GUI 工具、Windows UI Automation、视觉驱动交互、桌面应用网络抓包。 触发关键词:浏览器自动化、桌面自动化、打开网页、填表、爬取、截图、自动化登录、Playwright、agent-browser、headless、OpenReverse、UIA、CUA、桌面操作、Windows 自动化。
- Abrowser-extension-reverseUse for authorized reverse engineering of browser extensions (Chrome/Firefox) including manifest analysis, background workers, and extension-based credential or traffic logic recovery.
- Acase-reviewReviews 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.
- Acloud-k8sUse for authorized cloud, container, and Kubernetes security assessment including metadata SSRF, IAM misconfig, container escape paths, and cluster RBAC review.
- Acode-auditUse for authorized source-code security review and SAST workflows including Semgrep, CodeQL patterns, dangerous API hunting, and fix verification.
- Acompetition-ad-certificate-abuseInternal downstream skill for ctf-sandbox-orchestrator. CTF-sandbox workflow for AD CS, certificate templates, enrollment rights, EKUs, SAN controls, PKINIT, certificate mapping, and cert-based privilege paths. Use when the user asks about ESC-style abuse, certificate templates, enrollment agents, EKUs, SAN or subject controls, smartcard or PKINIT logon, CA policy, or how an issued cert turns into accepted privilege. Use only after `$ctf-sandbox-orchestrator` has already established sandbox assumptions and routed here.
- Acompetition-agent-cloudInternal downstream skill for ctf-sandbox-orchestrator. CTF-sandbox workflow for AI-agent, prompt-injection, MCP or toolchain, cloud, container, CI/CD, and supply-chain challenges. Use when the user asks to analyze prompt-to-tool flows, retrieval poisoning, mounted secrets, deployment drift, runtime-vs-manifest mismatches, registry provenance, or CI-produced artifacts under sandbox assumptions. Use only after `$ctf-sandbox-orchestrator` has already established sandbox assumptions and routed here.