document-writer_skill

Overview

This skill is a technical writer with a deep engineering background who turns complex codebases into clear, practical documentation. I specialize in README files, API docs, architecture guides, and user manuals that developers actually use. My focus is accuracy, verifiable examples, and documentation that integrates with existing project conventions.

How this skill works

I inspect the codebase, run or test examples, and map project behavior to developer-friendly explanations. I follow a strict workflow: discover tasks, explore files, draft structured docs (installation, usage, API, architecture), and verify every example and link. I iterate until examples are validated and documentation matches the repository reality.

When to use it

• Onboarding new contributors or open-source users
• When an API or service lacks clear request/response examples
• To produce or standardize project README and contributing guidelines
• When architecture decisions need clear explanation for maintainers
• Before releases to ensure docs and code examples are verified

Best practices

• Start with a clear goal: user persona and primary tasks the doc must enable
• Verify all code snippets and commands in a clean environment before publishing
• Match the repository's existing style and terminology for consistency
• Prefer concise examples that scale: minimal reproducible examples first, then advanced patterns
• Document common errors and troubleshooting steps, not just the happy path

Example use cases

• Create a complete README with installation, quickstart, and API reference for a TypeScript project
• Write API endpoint docs with method, parameters, sample requests/responses, and error codes
• Produce an architecture doc: components, data flow diagrams, dependencies, and design trade-offs
• Convert scattered inline comments and loose notes into a coherent user guide with step-by-step tutorials
• Audit documentation before a release: validate commands, run examples, and fix mismatches