| 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.
Run in your terminal
AI-first code editor with Composer
Before installing skills in Cursor, ensure your development environment meets these requirements:
node --versiondocs-generatorExecute the skills CLI command in your project's root directory to begin installation:
Package manager
npx skills install zhaoxuya520/reverse-skill/skills/docs-generatorFetches docs-generator from zhaoxuya520/reverse-skill and configures it for Cursor.
The CLI shows a list of agents. Use arrow keys and space to select Cursor:
Confirm successful installation by checking the skill directory location:
Restart Cursor to activate docs-generator. Access via /docs-generatorin your agent's command palette.
We perform automated surface-level scans (Gen AI Scanner, Socket, Snyk) during installation. These checks detect common vulnerabilities but do not guarantee complete security. Always review skill source code and verify the publisher's reputation before production use.
Skills execute code in your environment. Always review source, verify the publisher, and test in isolation before production.
Submit your Claude Code skill and start earning
Automate repetitive workflows and reduce manual effort
Example
Generate reports, summarize documents, draft communications
Save 3-5 hours per week on routine tasks
Learn new skills, understand complex topics, get expert guidance
Example
Explain concepts, provide examples, suggest learning resources
Accelerate learning and skill development by 2x
Enhance output quality through reviews, suggestions, and refinements
Example
Review drafts, suggest improvements, catch errors
Improve work quality by 30-40% with less effort
Package manager
npx skills install zhaoxuya520/reverse-skill/skills/docs-generatorWorks with
0
total installs
0
this week
10.9K
GitHub stars
0
upvotes
| name | docs-generator |
| description | | 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. |
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 负责在用户项目目录生成正式技术文档。
| 任务类型 | 使用模板 |
|---|---|
| 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 文档 |
YYYY-MM-DD_[类型]-[目标简称]-report.mddocs/ 目录：优先放在 docs/ 下../ops/evidence-finding-path.md 与模板 §0）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 直接渲染。
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.
<!-- Bad: Feature-oriented -->
## AuthService Class
The AuthService class provides authentication methods...
<!-- Good: Task-oriented -->
## Authenticating Users
To authenticate a user, call login() with credentials:
Every concept needs a concrete example.
| 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 |
For README, API endpoint, and file organization templates, see references/templates.md.
Skill(ce:writer) - Writing style, tone, and voice (load The Engineer persona)Skill(ce:visualizing-with-mermaid) - Architecture and flow diagrams本 skill 不依赖外部工具，纯文本生成。无需 bootstrap。
如果需要渲染图表嵌入报告，会调用 diagram-generator/ skill。
上游入口: 所有安全/逆向 skill 在任务完成后自动调用本 skill 触发方式:
同级关联模块:
apk-reverse/ — APK 逆向完成后生成逆向报告ida-reverse/ — 二进制分析完成后生成逆向报告radare2/ — CLI 分析完成后生成逆向报告js-reverse/ — JS 签名逆向完成后生成签名报告reverse-engineering/ — 通用逆向完成后生成逆向报告field-journal/ — 报告内容同时作为进化日志的数据来源安全报告模板: references/security-report-templates.md
通用文档模板: references/templates.md
tool-index 使用了真实工具路径？Prerequisites
Time Estimate
15-45 minutes depending on use case complexity
Steps
Common Pitfalls
✓ Do
✗ Don't
💡 Pro Tips
✓ Use when
Use when skill capabilities match your task, clear ROI on time saved, and you can validate outputs. Best for repetitive tasks, learning, and quality improvement.
✗ Avoid when
Avoid when task requires deep expertise you can't validate, involves sensitive decisions, or when learning process is more valuable than speed of completion.
Registry listing for docs-generator matched our evaluation — installs cleanly and behaves as described in the markdown.
Keeps context tight: docs-generator is the kind of skill you can hand to a new teammate without a long onboarding doc.
Keeps context tight: docs-generator is the kind of skill you can hand to a new teammate without a long onboarding doc.
We added docs-generator from the explainx registry; install was straightforward and the SKILL.md answered most questions upfront.
docs-generator reduced setup friction for our internal harness; good balance of opinion and flexibility.
I recommend docs-generator for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area.
docs-generator fits our agent workflows well — practical, well scoped, and easy to wire into existing repos.
docs-generator has been reliable in day-to-day use. Documentation quality is above average for community skills.
docs-generator has been reliable in day-to-day use. Documentation quality is above average for community skills.
Solid pick for teams standardizing on skills: docs-generator is focused, and the summary matches what you get after install.
showing 1-10 of 43