Communitygithub.com

docs-generator

セキュリティ/リバースエンジニアリングタスク完了後に、構造化された技術文書やレポートを自動生成するスキル。

docs-generator とは?

このスキルは、セキュリティ分析、リバースエンジニアリング、CTF、脆弱性調査などが完了した後に、ユーザーのプロジェクトディレクトリに正式な技術ドキュメントを自動生成します。主にClaude Code環境で動作し、タスクの種類(APKリバース、ペネトレーションテスト、CTF writeup、マルウェア分析など)に応じて適切なテンプレートを選択します。また、ベンダーレポートルールに基づき、マルウェア分析では火 Havoc式、APT分析ではKaspersky Securelist式などの構造化レポートを出力可能で、通常のリバースでは汎用テンプレートを使用します。出力はEvidence→Finding→Pathの連鎖を必須とし、必要に応じてMermaid図表(フローチャート、シーケンス図など)を埋め込むことで、可視性の高いレポートを生成します。

対応~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/zhaoxuya520/reverse-skill/tree/main/skills/docs-generator

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

技術文書生成スキル

即時実行必須事項(読んだらすぐ実行)

  1. NOW:現在のタスクが本スキルの適用範囲に該当するか確認する
  2. NOW:../tool-index.md を読み込み、ツールの利用可能性と実際のパスを検証する
  3. NEXT:ツールが不足している場合はbootstrapを呼び出す。パスを推測しないこと
  4. ACT:「ワークフロー」の最初のステップに進み実行する。確認状態で止まらないこと

文章スタイル、トーン、声については、Skill(ce:writer) をThe Engineerペルソナで使用してください。

セキュリティ/リバースエンジニアリングタスクの文書出力

リバースエンジニアリング、ペネトレーションテスト、CTF、セキュリティ分析タスクが完了した場合、本スキルはユーザープロジェクトディレクトリに正式な技術文書を生成します。

トリガー条件

  1. リバースエンジニアリングタスクが完了し、主要な結論(アルゴリズム復元、署名クラック、回避策など)が出ている
  2. ペネトレーションテストが完了し、脆弱性が発見・検証されている
  3. CTF問題が解かれ、フラグが取得されている
  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)

セキュリティ関連の正式レポートは、必ず references/vendor-report-rules.md を読み込むこと(構造のみ取得し、ベンダー原文をそのままコピーしないこと)。通常のリバースやその他のタスクでは flavor = null を使用します。ベンダーフレーバーは、タスクの証拠やユーザーが明示的に要求した場合にのみ選択します。

Flavor / Overlay使用タイミング主な参考骨格
malware明確なマルウェアサンプル、トロイの木馬、白+黒、フィッシング/毒盛火 Havoc形式:概要→フロー→サンプル分析→インシデント対応→IOC
aptAPT/キャンペーン/グループ/多段階感染チェーン/業界標的型攻撃Kaspersky Securelist形式:サマリー→感染チェーン→調査ストーリー→Interesting findings→技術分析→検出・緩和→IOC
flavor = null通常のAPK/ELF/PE/Mach-Oリバース、アルゴリズム/ファームウェア解析、ペネトレーション/CTF/JS署名元のタスクテンプレート+ベース共通要素。malware/APT専用のセクションは付与しない
thin vulnユーザーが脆弱性/パッチ/CVEの技術分析を明示的に要求した場合概要→影響/再現→クラッシュとパッチ分析→保護推奨事項(nullに重ねる。第3のデフォルト全文フレーバーではない)

原則:テンプレートは多すぎず精選する —— ベンダー全文フレーバーは2種類のみ。vuln はオプションのthin overlayであり、第3のデフォルトフルテンプレートセットは作成しない。 §0 Evidence→Finding→Path と同時に有効。競合時はEvidence契約を優先。

出力仕様

  • 出力場所:ユーザーの現在のプロジェクトディレクトリ(スキルパッケージディレクトリではない)
  • ファイル名形式:YYYY-MM-DD_[タイプ]-[ターゲット略称]-report.md
  • プロジェクトに docs/ ディレクトリがある場合:優先的に docs/ 以下に配置
  • エンコーディング:UTF-8
  • 言語:ユーザーの会話言語に従う(中国語の会話は中国語、英語の会話は英語)

品質要件

  • すべてのコードブロックは即座に実行可能であるか、明確なコンテキストを持つこと
  • プレースホルダーやTODOを残さないこと
  • 主要な発見には裏付けとなる証拠が必要
  • 再現手順は第三者による独立した再現が可能であること
  • 機密情報(実際のトークン、パスワード、内部URL)はプレースホルダーに置き換えること
  • 必須:Evidence → Finding → Path の連鎖を含めること(../ops/evidence-finding-path.md とテンプレート§0参照)
  • 必須:references/vendor-report-rules.md を読み込み、malware / apt または flavor = null を選択すること(脆弱性タスクでは thin vuln を重ね可能)。フレーバーがない場合は元のタスクテンプレートと適用可能なBase要素のみを出力し、IOC/ATT&CKは強制しない
  • 推奨:ケースの scope.md / timeline.md を参照すること(../scripts/case-init.ps1)

図表の統合

レポート生成時、適切な箇所で diagram-generator スキルを呼び出し、可視化図表を生成すること:

レポートタイプ推奨図表図表タイプ
リバースエンジニアリングレポート関数呼び出し関係図、データフロー図Mermaid flowchart / sequenceDiagram
ペネトレーションテストレポート攻撃パス図、ネットワークトポロジ図Mermaid flowchart / Graphviz
CTF Writeup問題解決フローチャートMermaid flowchart
JS 署名リバースレポートリクエスト連携シーケンス図、アルゴリズムフローチャートMermaid sequenceDiagram / flowchart

図表はMermaidコードブロックとしてレポートMarkdownに埋め込み、GitHub/GitLab上で直接レンダリング可能にすること。


基本原則

1. 段階的開示(Progressive Disclosure)

情報を階層的に表示する:

階層内容ユーザーの質問
11文での説明これは何か?
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) - アーキテクチャ図とフロー図

オンデマンドブートストラップ

本スキルは外部ツールに依存せず、プレーンテキスト生成のみです。ブートストラップは不要です。

レポートに図表を埋め込む必要がある場合は、diagram-generator/ スキルを呼び出します。


ルーティングコンテキスト

上流エントリポイント:すべてのセキュリティ/リバースエンジニアリングスキルは、タスク完了後に自動的に本スキルを呼び出します。 トリガー方法:

  • 自動:タスク完了後、アクションチェーンの第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(フレーバー: malware | apt | null;オプションオーバーレイ: vuln) 汎用文書テンプレート:references/templates.md

タスク完了セルフチェック(完了宣言前に必ずパスすること)

  • ワークフローの各ステップを実行したか(単に読んだだけではないか)?
  • tool-index に基づいて実際のツールパスを使用したか?
  • 再現可能な証拠(コマンド/スクリプト/スクリーンショット/レポート)を生成したか?
  • レポートにEvidence / Finding / Path(ops契約)が含まれているか?
  • RULESで要求されているチェックリスト項目を完了し、書き戻したか?

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.

関連スキル