# Generate Maintainable Documentation from Code

Outdated and inconsistent documentation slows development and creates support gaps. This skill turns code and configuration into structured documentation with validation and automation guidance.

## Install

```bash
npx skillstore add sickn33/documentation-generation-doc-generate
```

## Metadata

- Status: approved
- Slug: sickn33-documentation-generation-doc-generate
- Skillstore revision: r2
- Version status: missing
- Tree hash: 1f7ea19a2b674530ee8c2ffb42d15b656b6e9bd7848fb05a5a947989e2cd82cf
- Author: sickn33
- GitHub username: sickn33
- License: MIT
- Repository: https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/documentation-generation-doc-generate
- Ref: f9e2c34b4f19c7f3e6b0a1e93227b5f77cc12526
- Supported tools: Claude, Codex, Claude Code
- Audit status: complete
- Agent install advisory: allowed
- Manual install advisory: allowed
- Artifact signature: available
- Audit attestation: unavailable
- Human verification: not\_verified
- Risk factors: external\_commands, network, filesystem, env\_access
- Quality score: 79
- Quality tier: bronze
- Public page: https://skillstore.pages.dev/skills/sickn33-documentation-generation-doc-generate
- Manifest: https://skillstore.pages.dev/api/skills/sickn33-documentation-generation-doc-generate/manifest

## Capabilities

- Extracts API endpoints, parameters, schemas, and responses from source code.
- Drafts OpenAPI references, README files, user guides, and developer guides.
- Creates Mermaid architecture diagrams that describe components and data flows.
- Generates docstrings, configuration references, troubleshooting sections, and usage examples.
- Plans documentation linting, coverage checks, CI generation, and static-site deployment.
- Reports assumptions, missing information, validation needs, and follow-up tasks.

## Use Cases

- Document a Service API: Create endpoint references, authentication notes, request examples, and an OpenAPI outline from service code.
- Explain System Architecture: Turn components, dependencies, and data flows into maintainable diagrams and concise architecture notes.
- Standardize Repository Guides: Produce consistent setup, contribution, configuration, and troubleshooting guidance across project repositories.

## Prompt Templates

### Create a README

```
Review this repository and create a README for new developers. Include prerequisites, setup, configuration, basic usage, testing, and known gaps.
```

### Generate API Documentation

```
Analyze the API routes and schemas in [paths]. Draft endpoint documentation with authentication, parameters, responses, errors, and representative usage examples.
```

### Map the Architecture

```
Analyze the services and configuration in [paths]. Create a Mermaid architecture diagram and explain component responsibilities, dependencies, data flows, and reliability assumptions.
```

### Design a Documentation Pipeline

```
Audit documentation across this repository. Propose source-linked generation, linting, coverage checks, CI validation, publishing, ownership, and controls that prevent sensitive data exposure.
```

## Limitations

- Requires access to current source code, configuration, or reliable requirements.
- Generated documentation still requires technical review against real system behavior.
- Example automation must be adapted to the repository tools, permissions, and deployment environment.
- Sensitive values and internal endpoints must be removed before documentation is published.

## Best Practices

- Define the audience, documentation type, and source of truth before generating content.
- Verify generated claims against code, tests, configuration, and current deployment behavior.
- Use placeholders for credentials and review output for secrets, internal URLs, and sensitive data.

## Anti Patterns

- Do not publish generated documentation without technical review.
- Do not infer endpoints, configuration defaults, or guarantees that the source does not support.
- Do not copy secrets, private hostnames, customer data, or production values into documentation.

## Security Audit

- Audited at: 2026-07-23T22:47:27.956\+00:00
- Summary: All 30 static findings are false positives caused by prose, Markdown formatting, placeholders, and illustrative code or workflow examples. The skill contains no executable scripts and does not directly access commands, networks, files, or environment secrets. No prompt injection or malicious intent was found.

## Stats

- Views: 108
- Downloads: 16
- Favorites: 1
- Popularity score: 0