technical-writer

$npx mdskill add OneWave-AI/claude-skills/technical-writer

Creates clear technical documentation for users and teams

  • Identifies user needs to solve specific problems in documentation creation.
  • Deploys APIs and services like Markdown editors for content management.
  • Decides on appropriate templates and best practices based on audience and type of document.
  • Delivers final documents as structured files, ensuring clarity and accessibility.

SKILL.md

.github/skills/technical-writerView on GitHub ↗
---
name: technical-writer
description: Write comprehensive technical documentation including user guides, how-to articles, system architecture docs, onboarding materials, and knowledge base articles. Creates clear, structured documentation for technical and non-technical audiences. Use when users need technical writing, documentation, tutorials, or knowledge base content.
---

# Technical Writer

Create clear, comprehensive technical documentation for any audience.

## Contents
- `references/templates.md` — structure templates (user guide, tutorial, architecture)
- `references/best-practices.md` — clarity, structure, visuals, code, and quality checklist
- `references/special-types.md` — README, release notes, troubleshooting guide requirements
- `references/output-format.md` — final delivery wrapper and maintenance notes

## Workflow

1. Identify the documentation type. See `references/special-types.md` for the full type list and type-specific section requirements.

2. Determine the audience:
   - Technical level (beginner, intermediate, expert)
   - Role (end user, developer, admin, stakeholder)
   - Prior knowledge assumptions
   - Context (internal team, external customers, open source community)

3. Select and fill the matching structure template from `references/templates.md`. Start simple, then layer in complexity.

4. Apply technical writing best practices from `references/best-practices.md`: short sentences, active voice, specific instructions, scannable structure, runnable code examples, and a user-focused angle.

5. Verify the draft against the output quality checklist in `references/best-practices.md`.

6. Deliver using the wrapper in `references/output-format.md`, including the documentation checklist and maintenance notes.

## Example Triggers
- "Write user documentation for my feature"
- "Create a tutorial for setting up the development environment"
- "Document this system architecture"
- "Write a troubleshooting guide"
- "Create onboarding documentation for new developers"
- "Write a README for this project"

Generate professional, comprehensive technical documentation that enables users to succeed.

More from OneWave-AI/claude-skills

SkillDescription
accessibility-auditorAudit websites for accessibility issues and WCAG compliance. Use when checking accessibility, fixing a11y issues, or ensuring WCAG compliance.
agent-armyDeploy a 2-layer parallel agent hierarchy for large, parallelizable work — big refactors, multi-file migrations, codebase-wide audits, bulk generation. Layer 1 is 3-50+ specialist agents, each with its own full context window; Layer 2 is 2+ sub-agents per member. Includes git safety, tiered sizing, a pre-deploy gate, phantom-completion checks, and multi-wave follow-up.
agent-swarm-deployerDeploys swarms of sub-agents for massive parallel data processing tasks. Unlike agent-army (which is for code changes), this is for DATA tasks -- processing 1000 documents, analyzing datasets, bulk content generation. Configurable swarm size, task distribution, result aggregation, progress tracking, and error recovery.
agent-team-builderDesigns and deploys custom agent teams for specific business workflows. Interactive discovery of business processes, then generates complete team configurations with specialized agent roles, tool access, communication protocols, and handoff rules.
agent-to-agentAgent-to-Agent (A2A) communication protocol. Connect two or more Claude agents that pass messages, share context, delegate tasks, and collaborate. Implements structured handoffs, shared memory, and multi-agent conversations.
ai-readiness-assessmentAssesses how ready a business is for AI adoption across six dimensions. Evaluates data maturity, tech stack, team skills, process documentation, budget, and culture. Generates a comprehensive ai-readiness-report.md with scores, gap analysis, and recommended starting points. Aligned with OneWave AI's audit methodology.
api-documentation-writerGenerate comprehensive API documentation including endpoint descriptions, request/response examples, authentication guides, error codes, and SDKs. Creates OpenAPI/Swagger specs, REST API docs, and developer-friendly reference materials. Use when users need to document APIs, create technical references, or write developer documentation.
api-endpoint-scaffolderGenerate REST API endpoints with proper structure, validation, error handling, and types. Use when creating new API routes, endpoints, or backend services.
api-load-testerLoad tests API endpoints with progressive concurrency. Measures response times, error rates, throughput, and identifies breaking points. Generates a detailed report with latency percentiles, throughput curves, bottleneck analysis, and optimization recommendations.
athlete-social-media-managerCreate brand-safe content for athletes. Personal branding strategy, engagement optimization, crisis communication, sponsor integration.