# Create Clear Project Documentation

Inconsistent documentation makes projects difficult to understand and maintain. This skill provides adaptable templates for common technical documentation.

## Install

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

## Metadata

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

## Capabilities

- Structures README files with prioritized sections for setup, features, configuration, references, and licensing.
- Provides a per-endpoint API documentation template with parameters, responses, and examples.
- Supplies JSDoc and TSDoc guidance for parameters, returns, errors, and usage examples.
- Creates starter structures for changelogs and architecture decision records.
- Organizes llms.txt and retrieval-friendly documentation with clear hierarchies and self-contained sections.

## Use Cases

- Launch a Project README: Build a concise README that helps contributors install, configure, and understand a new project.
- Standardize API References: Apply one endpoint structure across parameters, responses, errors, and examples.
- Record Architecture Decisions: Capture decision context, status, consequences, and tradeoffs in a repeatable format.

## Prompt Templates

### Create a Basic README

```
Create a README for [project]. Include a one-line purpose, quick start, key features, configuration, documentation links, and license.
```

### Document an API Endpoint

```
Document [method and path]. Describe its purpose, parameters, successful response, common errors, and one realistic request and response example.
```

### Write an Architecture Decision

```
Draft an ADR for [decision]. Explain the context, chosen option, rejected alternatives, current status, consequences, and known tradeoffs.
```

### Design an AI-Friendly Documentation Set

```
Design documentation for [project] that supports people and retrieval systems. Include navigation, self-contained sections, an llms.txt outline, key concepts, and update ownership.
```

## Limitations

- The skill does not inspect a repository or generate project-specific facts automatically.
- Every template contains placeholders that require manual adaptation.
- The skill does not validate API behavior, code correctness, or documentation accuracy.
- It provides guidance only and includes no publishing or formatting automation.

## Best Practices

- Replace every placeholder with verified project information before publishing.
- Keep examples realistic and update them when behavior changes.
- Organize content from quick answers to detailed references.

## Anti Patterns

- Do not publish a template with unresolved placeholder text.
- Do not document behavior that has not been verified against the project.
- Do not repeat the same details across several files without clear ownership.

## Security Audit

- Audited at: 2026-07-23T22:50:20.821\+00:00
- Summary: All 15 static findings are false positives caused by fenced documentation examples and ordinary template wording. The skill contains no executable commands, system reconnaissance, prompt injection, or other semantic security concerns.

## Stats

- Views: 90
- Downloads: 10
- Favorites: 1
- Popularity score: 0