How do I install the Doc Writer skill?

Run npx skillmds@latest add claude-world-director-mode-lite/doc-writer in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Doc Writer safe to use?

This skill has not completed SkillMD's automated safety review yet. Capability flags: makes network calls. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Doc Writer?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Doc Writer free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Doc Writer?

claude-world (@claude-world-director-mode-lite) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Doc Writer by claude-world-director-mode-lite

Name: Doc Writer
Rating: 4.5 (4 reviews)
Author: claude-world

Doc Writer

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.

claude-world Updated Sep 10, 2026

File contents

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]

---name: doc-writerdescription: 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.---# Doc Writer Skill> **Director Mode Lite** - Documentation Specialist---## Documentation Types### 1. README.mdEssential sections:```markdown# Project NameBrief description (1-2 sentences)## Quick Start\`\`\`bashnpm install # Installationnpm start # Run\`\`\`## Features- Feature 1## Documentation- [Getting Started](docs/getting-started.md)- [API Reference](docs/api.md)## ContributingSee [CONTRIBUTING.md](CONTRIBUTING.md)## LicenseMIT```### 2. API DocumentationFor each endpoint/function:```markdown## `functionName(param1, param2)`Brief description.**Parameters:**- `param1` (string): Description- `param2` (number, optional): Description. Default: `10`**Returns:**- `ResultType`: Description**Example:**\`\`\`javascriptconst 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 CommentsComment 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.```javascript// 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.mdFollow Keep a Changelog format:```markdown# 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 DocsCover 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```markdown## Documentation Update### Files Created/Updated- `README.md` - Added Quick Start section### Summary[What documentation was added/changed and why]```

Frequently asked questions