generate-docs
/generate-docs
Generates comprehensive, production-grade documentation for the project. Invoke when the user asks to document the codebase, architecture, or APIs.
- Author
- LeonardoEnnes ↗
- Repository
- ai-engineering-toolkit ↗
- Licence
- Apache-2.0
- Last repository change
- 06.11.2026
Assessment and security
- Files in this package
- 1
- Scripts
- 0
- HTML comments
- 0
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 06.11.2026, without references to retired models or APIs.
Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.
What it does and when to use it
Generates comprehensive, production-grade documentation for the project. Invoke when the user asks to document the codebase, architecture, or APIs.
Original author description
Generates comprehensive, production-grade documentation for the project. Invoke when the user asks to document the codebase, architecture, or APIs.
How it works
SKILL.md has no level-two headings · 26 lines, 243 words
SKILL.md preview
--- name: "generate-docs" description: "Generates comprehensive, production-grade documentation for the project. Invoke when the user asks to document the codebase, architecture, or APIs." --- # Documentation Generator (Enterprise Grade) <instructions> When asked to generate documentation for a project or feature, do not just output a simple README. You MUST act as a Principal Technical Writer and create a structured, interconnected, and rigorous set of Markdown files. **1. Documentation Structure:** Unless specified otherwise, generate or suggest the following structure inside a `docs/` folder: - `README.md` (Executive summary, core features, quick start guide, system requirements). - `docs/ARCHITECTURE.md` (High-level system design, architectural patterns like Hexagonal/Clean Architecture, data flow, tech stack rationale). - `docs/API.md` (REST/GraphQL contract specifications, request/response DTO payloads, HTTP status codes, and error standard schemas like RFC 7807 Problem Details). - `docs/CONTRIBUTING.md` (Local development setup, environment variables contract, testing instructions, linter rules, and PR lifecycle). **2. Deep Content Extraction:** - Inspect configuration files (`pom.xml`, `package.json`, `pyproject.toml`, `docker-compose.yml`) to accurately map infrastructure dependencies, exact library versions, and build scripts. - Extract all environment variables from `.env.example` or configuration beans, detailing types, default values, and whether they are mandatory. - Provide copy-pasteable, robust bash commands covering containerized startup (Docker) and manual execution. **3. Visual Architecture (Mermaid.js):** - You MUST include at least one Mermaid diagram per major file. - In `ARCHITECTURE.md`, use a Component or Sequence diagram mapping how layers interact (e.g., Controller -> Service -> Repository -> DB / Kafka). **4. Interconnectivity & Maintenance:** - Use strict relative Markdown links between documents (e.g., `[Architecture Guide](./docs/ARCHITECTURE.md)`). - Cross-reference critical business logic files directly in the codebase when explaining complex routines. </instructions>
Versions
| Repository | Score | Licence |
|---|---|---|
| This page · LeonardoEnnes/ai-engineering-toolkit | 96 | Apache-2.0 |
| gohypergiant/agent-skills | 95 | Apache-2.0 |
| primelogiclabio/claude-generate-docs | 93 | MIT |
Database snapshot: 13.11.2026 · package version 51872bd36b69 (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100project-docs
Generate project documentation from codebase analysis — ARCHITECTURE.md, API_ENDPOINTS.md, DATABASE_SCHEMA.md. Reads source code, schema files, routes, and config to produce accurate, structured docs. Use when starting a project, onboarding contributors, or when docs are missing… - 100documentation-generator
Generate comprehensive documentation for a codebase by reading the repository and producing READMEs, API docs, architecture docs, and technical references. Use when the user asks to "document this repo", "generate docs", "write a README", "create API documentation", "document… - 100documentation-generation-doc-generate
Generate API docs, architecture diagrams, user guides, and technical references from code, keeping documentation comprehensive and maintainable. Use when creating or updating documentation for a codebase. - 100generating-api-docs
Create comprehensive API documentation with examples, authentication guides, and SDKs. Use when creating comprehensive API documentation. Trigger with phrases like "generate API docs", "create API documentation", or "document the API". - 100generating-api-docs
Create comprehensive API documentation with examples, authentication guides, and SDKs. Use when creating comprehensive API documentation. Trigger with phrases like "generate API docs", "create API documentation", or "document the API". - 95unikit-docs
Generate and maintain the project's TECHNICAL documentation from its codebase — scans the project structure, tech stack, and module boundaries, then writes a lean README landing page plus detailed topic pages (architecture, modules, setup, build, APIs), only the docs that are…