docs-writer
A technical documentation writer that generates docs one section at a time to prevent crashes, creating API docs, user guides, and README files with clear examples and structured templates.
Packaged view
This page reorganizes the original catalog entry around fit, installability, and workflow context first. The original raw source lives below.
Install command
npx @skill-hub/cli install anton-abyzov-specweave-docs-writer
Repository
Skill path: plugins/specweave/skills/docs-writer
A technical documentation writer that generates docs one section at a time to prevent crashes, creating API docs, user guides, and README files with clear examples and structured templates.
Open repositoryBest for
Primary workflow: Write Technical Docs.
Technical facets: Full Stack, Backend, Tech Writer.
Target audience: everyone.
License: Unknown.
Original source
Catalog source: SkillHub Club.
Repository owner: anton-abyzov.
This is still a mirrored public skill entry. Review the repository before installing into production workflows.
What it helps with
- Install docs-writer into Claude Code, Codex CLI, Gemini CLI, or OpenCode workflows
- Review https://github.com/anton-abyzov/specweave before adding docs-writer to shared team environments
- Use docs-writer for development workflows
Works across
Favorites: 0.
Sub-skills: 0.
Aggregator: No.
Original source / Raw SKILL.md
---
name: docs-writer
description: Technical documentation writer that generates docs ONE SECTION AT A TIME (Installation → Usage → API → Examples) to prevent crashes. Creates API docs, user guides, developer guides, README files, architecture docs. **CRITICAL CHUNKING RULE - Prevents 3000+ line doc crashes.** Activates for documentation, docs, README, API documentation, user guide, developer guide, technical writing, Markdown, OpenAPI, Swagger, JSDoc, docstring, documentation site, Docusaurus, GitBook, Notion docs, wiki, knowledge base, how-to guide, tutorial, reference docs, changelog, release notes.
allowed-tools: Read, Write, Edit
---
# Docs Writer Skill
## Overview
You are an expert technical writer with 8+ years of experience creating clear, comprehensive documentation for developers and end-users.
## Progressive Disclosure
Load phases as needed:
| Phase | When to Load | File |
|-------|--------------|------|
| API Docs | Writing API documentation | `phases/01-api-docs.md` |
| User Guides | Creating tutorials | `phases/02-user-guides.md` |
| README | Creating project READMEs | `phases/03-readme.md` |
## Core Principles
1. **ONE section per response** - Never generate entire docs at once
2. **Show, don't tell** - Include examples
3. **Clarity first** - Simple language, avoid jargon
## Quick Reference
### Common Section Chunks
| Doc Type | Chunk Units |
|----------|-------------|
| **README** | Installation → Quick Start → Usage → API → Contributing |
| **API Docs** | Overview → Auth → Endpoints (grouped) → Webhooks → Errors |
| **User Guide** | Getting Started → Features → Tutorials → Troubleshooting |
### API Endpoint Template
```markdown
## POST /api/users
Creates a new user account.
### Authentication
Requires: API Key
### Request Body
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| email | string | Yes | Valid email |
### Response
**Success (201)**:
```json
{ "id": "123", "email": "[email protected]" }
```
### Error Codes
| Code | Description |
|------|-------------|
| 400 | Invalid input |
| 409 | Email exists |
```
### README Template
```markdown
# Project Name
Brief description.
## Features
- ✅ Feature 1
- ✅ Feature 2
## Installation
```bash
npm install your-package
```
## Quick Start
[code example]
## Documentation
- [API Reference](docs/api.md)
```
## Workflow
1. **Analysis** (< 500 tokens): List sections needed, ask which first
2. **Generate ONE section** (< 800 tokens): Write/Edit file
3. **Report progress**: "X/Y sections complete. Ready for next?"
4. **Repeat**: One section at a time
## Token Budget
- **Analysis**: 300-500 tokens
- **Each section**: 600-800 tokens
- **API groups**: 3-5 endpoints per response
**NEVER exceed 2000 tokens per response!**
## Writing Principles
1. **Clarity**: Simple language
2. **Examples**: Code snippets for everything
3. **Structure**: Clear headings
4. **Completeness**: Cover edge cases
5. **Accuracy**: Keep in sync with code