# Build Complete Technical Documentation

Software documentation often becomes fragmented across formats and project stages. This skill provides a phased workflow for planning, creating, publishing, and maintaining it.

## Install

```bash
npx skillstore add sickn33/documentation
```

## Metadata

- Status: approved
- Slug: sickn33-documentation
- Skillstore revision: r2
- Version status: missing
- Tree hash: b4b7832309b7246e256a7c3767eaa2f92d02d8df4f7cbdfc76ebbe9874ad7a7e
- Author: sickn33
- GitHub username: sickn33
- License: MIT
- Repository: https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/documentation
- 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
- Quality score: 78
- Quality tier: bronze
- Public page: https://skillstore.pages.dev/skills/sickn33-documentation
- Manifest: https://skillstore.pages.dev/api/skills/sickn33-documentation/manifest

## Capabilities

- Organizes documentation work into eight phases from planning through maintenance.
- Directs API reference and OpenAPI specification workflows.
- Coordinates C4 and Mermaid architecture documentation.
- Covers code comments, function references, and usage examples.
- Plans README files, tutorials, wikis, and onboarding guides.
- Defines release documentation tasks and six documentation quality gates.

## Use Cases

- Document a new service: Plan a README, API reference, setup guide, and examples for a software service.
- Describe system architecture: Coordinate context, container, component, sequence, data flow, and deployment documentation.
- Maintain a documentation portal: Structure wiki pages, onboarding guides, release notes, references, and recurring quality reviews.

## Prompt Templates

### Outline project documentation

```
Create a documentation plan for [project], including its audience, README sections, setup guide, usage examples, and review checklist.
```

### Plan an API reference

```
Plan API documentation for [service] from [source], covering endpoints, schemas, authentication, examples, OpenAPI output, and validation.
```

### Design architecture documentation

```
Design a C4 documentation set for [system], including context, containers, components, data flows, sequences, deployment, and Mermaid diagrams.
```

### Coordinate the full workflow

```
Build a phased documentation program for [product], assigning deliverables, specialist skills, dependencies, quality gates, owners, and maintenance intervals.
```

## Limitations

- Requires separately available named skills for specialized generation tasks.
- Provides workflow guidance but includes no scripts, templates, or publishing configuration.
- Generated documentation still requires technical review and environment-specific validation.
- Does not verify links, examples, APIs, or diagrams automatically.

## Best Practices

- Define audiences, scope, owners, and quality criteria before generating content.
- Validate every example, link, diagram, and API statement against the current system.
- Update documentation with code, interface, deployment, and release changes.

## Anti Patterns

- Do not invoke every listed specialist skill when the task needs only one document.
- Do not publish generated technical claims without review by a responsible subject expert.
- Do not create duplicate references when an authoritative source already exists.

## Security Audit

- Audited at: 2026-07-23T22:44:14.95\+00:00
- Summary: All 63 static findings were reviewed against SKILL.md. The 61 execution alerts are Markdown syntax, while both reconnaissance alerts are ordinary documentation text without executable behavior or malicious intent.

## Stats

- Views: 214
- Downloads: 15
- Favorites: 1
- Popularity score: 0