본문으로 건너뛰기
cccskills
무료GitHub에 공개

docs-generator

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.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

skillmds/skillmd
설치 방법 보기

포함된 파일(3)

  • SKILL.md6.3 KB
  • references/security-report-templates.md5.7 KB
  • references/templates.md1.9 KB

SKILL.md(원문)

설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.

Technical Documentation

ACTION REQUIRED（读完后立刻执行）

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

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）用占位符替代
  • MUST 包含 Evidence → Finding → Path 链（见 ../ops/evidence-finding-path.md 与模板 §0）
  • 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 直接渲染。

Core Principles

1. Progressive Disclosure

Reveal information in layers:

LayerContentUser Question
1One-sentence descriptionWhat is it?
2Quick start code blockHow do I use it?
3Full API referenceWhat are my options?
4Architecture deep diveHow 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

ProblemFix
Wall of textBreak up with headings, bullets, code, tables
Buried critical infoWarnings/breaking changes at TOP
Missing error docsAlways 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

任务完成自检（声称完成前 MUST 通过）

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

리뷰

아직 리뷰가 없습니다. 사용해 본 소감을 남겨 주세요.

댓글

로그인 없이 쓸 수 있습니다. 사용 후기, 질문, 작동하지 않은 환경 등을 편하게 남겨 주세요.

아직 댓글이 없습니다. 첫 댓글을 남겨 보세요.

보내면 바로 공개됩니다. 이메일 주소나 전화번호 같은 개인 정보는 쓰지 마세요. URL은 2개까지입니다.

0 / 1,000자

이 양식은 reCAPTCHA로 보호되며 Google 개인정보처리방침 및 서비스 약관이 적용됩니다.

같은 저장소의 스킬

academic-pptx

무료

Use this skill whenever the user wants to create or improve a presentation for an academic context — conference papers, seminar talks, thesis defenses, grant briefings, lab meetings, invited lectures, or any presentation where the audience will evaluate reasoning and evidence. Triggers include: 'conference talk', 'seminar slides', 'thesis defense', 'research presentation', 'academic deck', 'academic presentation'. Also triggers when the user asks to 'make slides' in combination with academic content (e.g., 'make slides for my paper on X', 'create a presentation for my dissertation defense', 'build a deck for my grant proposal'). This skill governs CONTENT and STRUCTURE decisions. For the technical work of creating or editing the .pptx file itself, also read the pptx SKILL.md.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

skillmds/skillmd2492026년 10월 14일 업데이트

adp

무료

Redpanda's Agentic Data Plane: governance infrastructure for building, running, and governing AI agents and MCP servers, plus a proxying AI Gateway for LLM providers, operated via `rpk ai` and the ADP API. Use when creating or managing AI agents (managed or self-managed) via `rpk ai agent` or `AgentRegistryService`; configuring MCP servers (remote or managed catalog, code mode, auth); setting up LLM providers or querying models via `rpk ai llm`/`rpk ai model` or the AI Gateway proxy; or configuring budgets, guardrails, or Cedar access-control policies through the governance APIs. Also covers reading agent transcripts and spending insights, and wiring OAuth clients or providers to the aigw Authorization Server. For the separate rpk cloud mcp control-plane MCP server, see `/redpanda:rpk-cloud`.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

skillmds/skillmd2492026년 10월 14일 업데이트

ads

무료

Operate professional paid advertising across Google, Meta, YouTube, LinkedIn, TikTok, Microsoft, Apple, Amazon, Reddit, Pinterest, Snapchat, and X. Use for account intake, source-grounded audits, strategy, budget and measurement planning, creative production, experiments, reporting, monitoring, and explicitly approved campaign changes. Also trigger on PPC, paid social, retail media, attribution, tracking, landing pages, cross-platform conversion totals, negative keywords or search terms, beta-feature scoring, stale platform claims, API-token or credential setup, campaign deletion, and safe Claude Ads installation or uninstall.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

skillmds/skillmd2492026년 10월 14일 업데이트

ads-apple

무료

Audit Apple Ads measurement, AdServices and AdAttributionKit, campaign and keyword structure, Search Match, App Store placements, custom product pages, bidding, budgets, MMP reconciliation, and policy. Use for Apple Ads, Apple Search Ads, App Store ads, Search Match, custom product pages, AdServices, or Apple app-install campaigns.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

skillmds/skillmd2492026년 10월 14일 업데이트

ads-competitor

무료

Research competitor paid-ad presence, messaging, creative, formats, landing pages, keyword and auction signals, transparent ad libraries, and strategic gaps across supported platforms. Use for competitor ads, ad libraries, ad spy, competitive PPC analysis, competitor creative, Google Ads Transparency, Meta Ad Library, or paid-media competitor research.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

skillmds/skillmd2492026년 10월 14일 업데이트

ads-dna

무료

Extract a public-safe brand and offer profile for paid advertising from an authorized website and operator input. Triggers on: brand DNA, brand profile, brand identity, brand style, brand colors, brand voice, visual identity, style guide, website brand analysis.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

skillmds/skillmd2492026년 10월 14일 업데이트

skillmds의 스킬 모두 보기

이 스킬의 문제 신고