hgxszhj/https-github.com-zhaoxuya520-reverse-skill / skills/docs-generator
docs-generator
VerifiedCreates 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.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 8.1 KB |
| references/security-report-templates.md | markdown | 8.0 KB |
| references/templates.md | markdown | 1.9 KB |
| references/vendor-report-rules.md | markdown | 11.3 KB |
references/templates.md
View on GitHub# Documentation Templates
## Contents
- [README.md](#readmemd)
- [API Endpoint Documentation](#api-endpoint-documentation)
- [File System Organization](#file-system-organization)
## README.md
```markdown
# Project Name
One-line description of what this does.
## Quick Start
\`\`\`bash
yarn install && yarn dev
\`\`\`
## Installation
Step-by-step setup.
## Usage
\`\`\`typescript
import { thing } from "package";
const result = thing.doSomething();
\`\`\`
## Configuration
| Variable | Required | Default | Description |
| --------- | -------- | ------- | ------------ |
| `API_KEY` | Yes | - | Your API key |
## Documentation
- [API Reference](./docs/api/README.md)
- [Architecture](./docs/architecture/overview.md)
```
## API Endpoint Documentation
```markdown
# Resource Name
Brief description.
## GET /resource
Retrieves resources.
**Parameters**
| Name | Type | Required | Description |
| ------- | ------ | -------- | ------------------------- |
| `limit` | number | No | Max results (default: 20) |
**Response**
\`\`\`json
{
"data": [...],
"total": 100
}
\`\`\`
**Example**
\`\`\`typescript
const { data } = await api.get("/resource", { limit: 10 });
\`\`\`
**Errors**
| Status | Code | Description |
| ------ | ---------------- | ------------------------ |
| 400 | `INVALID_PARAMS` | Invalid query parameters |
| 401 | `UNAUTHORIZED` | Missing or invalid auth |
```
## File System Organization
```
/docs
├── README.md # Docs index
├── /api
│ ├── README.md # API overview
│ ├── authentication.md
│ └── {resource}.md
├── /architecture
│ ├── overview.md
│ └── data-flow.md
├── /guides
│ ├── getting-started.md
│ └── troubleshooting.md
└── /features
└── {NNN}-{feature}.md
```
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit. | Stars: 467k | Updated | Claude CodeCodex | Verified | Install |
| rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure. | Stars: 467k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 467k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 193k | Updated | Claude CodeCodex | Verified | Install |