Documentation writer
Skill AtulPurohit/Antigravity-Awesome-Skills/skills/documentation-writer
Write clear, comprehensive technical documentation. Covers README files, API docs, tutorials, architecture guides, and documentation systems.From its SKILL.md
npx -y skills add AtulPurohit/Antigravity-Awesome-Skills --skill documentation-writerAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
- 3 stars3 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
3.1 KB, 601 tokens by cl100k_base, as published. Nobody here has run it
Documentation Writer
Purpose
Create documentation that developers actually read and use, reducing friction and support burden.
Documentation Types
1️⃣ README Best Practices
# Project Name
> One-line description of what this project does.
[](LICENSE)
[](...)
[](...)
## What is this?
[2-3 sentence explanation for someone who has never heard of this]
## Quick Start
[The absolute minimum to get something running in < 5 minutes]
```bash
npm install package-name
import { feature } from 'package-name';
const result = feature('hello');
Features
- ✅ Feature one (benefit, not just name)
- ✅ Feature two
Installation
[Detailed installation including prerequisites]
Usage
[Common use cases with complete examples]
API Reference
[Complete API documentation or link to it]
Contributing
[How to contribute, run tests, submit PRs]
License
MIT
### 2️⃣ API Documentation (OpenAPI + Examples)
Every endpoint should document:
- What it does (human readable)
- Request: URL, method, headers, body (with schema and examples)
- Response: status codes, body (with schema and examples)
- Errors: all possible error codes and messages
- Authentication: what's required
- Rate limits: if applicable
- Code examples in multiple languages (curl, JS, Python)
### 3️⃣ Architecture Documentation
Use ADRs (Architecture Decision Records):
```markdown
# ADR-001: Use PostgreSQL for Primary Database
## Status: Accepted
## Context
We need to store user profiles, orders, and analytics data.
The data has complex relationships and requires ACID transactions.
## Decision
Use PostgreSQL 16 as our primary database.
## Rationale
- Mature, battle-tested for 20+ years
- Full ACID compliance for financial data
- JSON support for flexible metadata
- Team has deep PostgreSQL expertise
- Excellent tooling (pgAdmin, migrations, backups)
## Alternatives Considered
- MySQL: Similar capabilities, less advanced features
- MongoDB: Better for unstructured data, but our data is relational
## Consequences
✅ Strong consistency and reliability
✅ Complex queries with JOINs
❌ Harder to scale horizontally than NoSQL
❌ Schema migrations require planning
Outputs
- README template with all sections
- API documentation in OpenAPI format
- Architecture decision records
- Onboarding guide for new developers
- Runbook / operations guide
What ships with it
Read from the repository
Just SKILL.md. No reference files, no scripts.