Doc writer

Skill claude-world/director-mode-lite/skills/doc-writer

Use Claude Code like a Director, not a Programmer. MIT toolkit with Auto-Loop, guided setup, 27 commands, 14 agents, and 32 skills.

Install

npx -y skills add claude-world/director-mode-lite --skill doc-writer

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

What its author says it does

Copied from the file, not written here

Documentation templates and standards: README structure, API reference format, changelog (Keep a Changelog), and comment guidelines. Use when creating or updating documentation. Loaded automatically by the doc-writer agent.

SKILL.md

2.9 KB, as published. Nobody here has run it

Doc Writer Skill

Director Mode Lite - Documentation Specialist

Documentation Types

1. README.md

Essential sections:

# Project Name

Brief description (1-2 sentences)

## Quick Start
\`\`\`bash
npm install   # Installation
npm start     # Run
\`\`\`

## Features
- Feature 1

## Documentation
- [Getting Started](docs/getting-started.md)
- [API Reference](docs/api.md)

## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md)

## License
MIT

2. API Documentation

For each endpoint/function:

## `functionName(param1, param2)`

Brief description.

**Parameters:**
- `param1` (string): Description
- `param2` (number, optional): Description. Default: `10`

**Returns:**
- `ResultType`: Description

**Example:**
\`\`\`javascript
const result = functionName('hello', 5);
// => { success: true }
\`\`\`

**Throws:**
- `ValidationError`: When param1 is empty

For REST endpoints, document the method and path, request headers/body, success and error responses, and a runnable curl example.

3. Code Comments

Comment complex algorithms, non-obvious business logic, workarounds (and why), and TODOs with context. Do NOT comment self-explanatory code or restate what the code already says.

// Calculate compound interest using continuous compounding formula
// This matches the bank's calculation method (see SPEC-123)
const interest = principal * Math.exp(rate * time);

4. CHANGELOG.md

Follow Keep a Changelog format:

# Changelog

## [1.2.0] - 2025-01-15
### Added
- New feature X
### Changed
- Improved performance of Y
### Fixed
- Bug in Z
### Removed
- Deprecated API endpoint

5. Architecture Docs

Cover the system overview, component relationships, data flow, and design decisions with their rationale.

Documentation Standards

Style

Use active voice; keep sentences concise
Define acronyms on first use; use consistent terminology
Write for scanning: H1 for the title, H2/H3 for sections, lists, and bold key terms

Code Examples

Make examples complete and runnable; include expected output
Show both basic and advanced usage; handle errors

Principles

Keep it current: update docs in the same PR as the code change
Write for the reader: assume minimal context, lead with the common case
Test your docs: follow your own instructions; verify every example runs

Output Format

## Documentation Update

### Files Created/Updated
- `README.md` - Added Quick Start section

### Summary
[What documentation was added/changed and why]