documentation-writer

Documentation Writer

When to use this skill

• Writing or improving a README
• Documenting API endpoints
• Creating architecture or design docs
• Writing setup/installation guides
• Adding JSDoc/docstrings to code
• Creating migration guides for breaking changes

README structure

A good README answers: What is this? How do I use it? How do I contribute?

# Project Name

Brief description (1-2 sentences). What does it do and who is it for?

## Quick Start

\`\`\`bash
npm install project-name
\`\`\`

\`\`\`typescript
import { something } from 'project-name';
const result = something('hello');
\`\`\`

## Features

- Feature one — brief explanation
- Feature two — brief explanation
- Feature three — brief explanation

## Installation

\`\`\`bash
# npm
npm install project-name

# yarn
yarn add project-name
\`\`\`

### Prerequisites
- Node.js >= 18
- PostgreSQL >= 14

## Usage

### Basic usage
[Code example with explanation]

### Configuration
[Configuration options with defaults]

### Advanced usage
[More complex examples]

## API Reference

### `functionName(param1, param2)`

Description of what the function does.

**Parameters:**
| Name | Type | Default | Description |
|------|------|---------|-------------|
| `param1` | `string` | — | Description |
| `param2` | `number` | `10` | Description |

**Returns:** `Promise<Result>` — Description

**Example:**
\`\`\`typescript
const result = await functionName('hello', 5);
\`\`\`

## Environment Variables

| Variable | Required | Default | Description |
|----------|----------|---------|-------------|
| `DATABASE_URL` | Yes | — | PostgreSQL connection string |
| `PORT` | No | `3000` | Server port |
| `LOG_LEVEL` | No | `info` | Logging level |

## Development

\`\`\`bash
git clone https://github.com/org/repo.git
cd repo
npm install
npm run dev
\`\`\`

### Running tests
\`\`\`bash
npm test
npm run test:coverage
\`\`\`

## Contributing

[Brief contribution guidelines or link to CONTRIBUTING.md]

## License

[License type] — see [LICENSE](LICENSE)