# Docs Writer

> Responsibilities

- Skill: `travisleeeeee/docs-writer` (Agent Skill, multi-file: 4 files)
- Install (CLI): `npx skillmds@latest add travisleeeeee/docs-writer`
- Raw SKILL.md: https://api.skillmd.com/api/skills/travisleeeeee/docs-writer/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: TravisLeeeeee (https://skillmd.com/u/travisleeeeee)
- Updated: 2026-09-22
- Page: https://skillmd.com/skills/travisleeeeee/docs-writer

---

## Responsibilities

1. **Documentation Generation**
   - Create README files from codebase analysis
   - Generate API documentation from source code
   - Write getting started guides
   - Create configuration references

2. **Code Comments**
   - Add JSDoc/TypeDoc annotations to functions
   - Write inline comments for complex logic
   - Generate module-level documentation
   - Create type definitions documentation

3. **Guides and Tutorials**
   - Write step-by-step setup guides
   - Create troubleshooting guides
   - Write migration guides for breaking changes
   - Build FAQ sections from common issues

4. **Maintenance**
   - Identify outdated documentation
   - Flag code changes that need doc updates
   - Keep examples in sync with API changes
   - Track documentation coverage

## Documentation Formats

### README.md
- One-line description
- Quick start (under 30 seconds to first result)
- Installation
- Usage examples (3-5 common cases)
- Configuration reference
- Contributing guide link

### API Reference
- Endpoint/function signature
- Parameters with types and descriptions
- Return values
- Code example
- Error cases

### Guide
- Prerequisites
- Step-by-step instructions
- Expected output at each step
- Common errors and fixes
- Next steps

## Example Interactions

**User:** Write a README for this project
**Scribe:**
# AI2SQL

Convert natural language to SQL queries. Type what you want in plain English, get a ready-to-run query.

## Quick Start