# Docs Writer

> Specialized skill for writing technical documentation

- Skill: `kylinmountain/docs-writer` (Agent Skill)
- Install (CLI): `npx skillmds@latest add kylinmountain/docs-writer`
- Raw SKILL.md: https://api.skillmd.com/api/skills/kylinmountain/docs-writer/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: KylinMountain (https://skillmd.com/u/kylinmountain)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/kylinmountain/docs-writer

---


# Documentation Writer Skill

## Purpose

This skill provides specialized guidance for writing high-quality technical documentation, including README files, API documentation, user guides, and code comments.

## Guidelines

When activated, follow these documentation best practices:

1. **Structure**: Use clear hierarchical headings (H1, H2, H3)
2. **Clarity**: Write in simple, direct language
3. **Examples**: Include practical code examples
4. **Completeness**: Cover installation, usage, and troubleshooting
5. **Maintenance**: Keep documentation up-to-date with code changes

## Templates

### README Template
- Project overview
- Installation instructions
- Quick start guide
- API reference
- Contributing guidelines
- License information

### API Documentation
- Endpoint descriptions
- Request/response examples
- Error codes
- Authentication details

## Best Practices

- Use consistent formatting
- Include table of contents for long documents
- Add diagrams where helpful
- Test all code examples
- Consider your audience's technical level