doc-writer

name	doc-writer
description	Assists with writing and improving project documentation including READMEs, architecture docs, API references, and user guides. Use when the user wants to write docs, update a README, document an API, or create a user guide.
version	1.0.0
triggers	["write documentation","update the README","document this","create a user guide","write API docs","improve the docs"]
negative_triggers	["delete docs","remove documentation"]
allowed_tools	[]
required_tools	[]
examples	["Write or improve a README, API reference, user guide, architecture note, or changelog."]
tests	["sb skills validate --path skills --strict"]
performance	{"notes":"Best for documentation drafting, structure review, and stale reference cleanup."}

Documentation Writer

Purpose

Help the user produce clear, well-structured project documentation that follows best practices.

Instructions

1. Identify the doc type: README, architecture doc, API reference, user guide, or changelog.
2. Gather context: Read relevant source files, existing docs, and project structure.
3. Draft with structure: Use consistent headings, code examples, and cross-references.
4. Apply best practices:
   • Lead with a one-sentence summary
   • Include quick-start / installation section
   • Provide concrete code examples
   • Add troubleshooting section for user-facing docs
   • Keep language concise and scannable
5. Review: Check for broken links, outdated references, and completeness.

Templates

README Template

# Project Name

One-line description.

## Quick Start

Installation and first-run instructions.

## Usage

Core commands and workflows.

## Configuration

Key settings and environment variables.

## Architecture

High-level design overview.

## Contributing

How to contribute.

API Reference Template

# API Reference

## `function_name(param1, param2)`

Description of what it does.

**Parameters:**
- `param1` (type): Description
- `param2` (type): Description

**Returns:** Description of return value

**Example:**
(code block)

Troubleshooting

Symptom	Cause	Fix
Docs feel too long	No clear structure	Add table of contents, use headings
Examples don't work	Outdated code	Test examples against current codebase
Missing context	Assumed knowledge	Add prerequisites section