Technical Documentation

For writing style, tone, and voice guidance, use Skill(ce:writer) with The Engineer persona.

安全/逆向任务文档输出

当逆向/渗透/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 → 签名逆向报告
通用技术文档	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