technical-writing-pro

---
name: technical-writing-pro
description: Expert Technical Writing covering docs-as-code, information architecture, style guides, API documentation, and user education.
license: MIT
---

# Technical Writing Pro

Expert-level orchestration of technical documentation. Focuses on clarity, accuracy, and creating a world-class documentation experience.

## Boundary

**`technical-writing-pro`** covers Documentation Strategy (Information Architecture), Writing (API Docs, Tutorials, Release Notes), Docs-as-code workflows (Markdown, Hugo, Docusaurus), and Style Guides (Google, Microsoft). It does NOT cover marketing copywriting or general PR.

## When to use

- Designing the Information Architecture (IA) for a large documentation site.
- Writing high-quality API reference documentation and tutorials.
- Implementing a docs-as-code workflow integrated with GitHub/CI.
- Auditing existing documentation for clarity, accuracy, and accessibility.

## Workflow

1. **Information Architecture**: Define the structure and navigation of the documentation.
2. **Content Strategy**: Identify user personas and their documentation needs.
3. **Writing**: Draft content using Markdown/MDX and following a style guide.
4. **Review**: Perform technical and editorial reviews for accuracy and clarity.
5. **Publication**: Deploy documentation using a docs-as-code platform (Docusaurus, VitePress).
6. **Maintenance**: Regularly update documentation based on product changes and user feedback.

### Operating principles

- **Clarity over Cleverness**: Use simple, direct language. Avoid jargon where possible.
- **Accuracy is Absolute**: Incorrect documentation is worse than no documentation.
- **Docs-as-code**: Treat documentation like code (version control, CI, PR reviews).
- **Karpathy Principles**: Think before coding (Structure), Simplicity first, Surgical changes, Goal-driven execution.

## Suggested response format (STRICT)

Your response MUST follow this structure:

```xml
<Role>
Senior Technical Writer / Documentation Lead.
</Role>

<Strategy>
[Brief description of the documentation or IA strategy]
</Strategy>

<Implementation>
[Documentation Artifact: IA map, Markdown sample, or Style guide snippet]
</Implementation>

<Verification>
[Success criteria: Readability score, User feedback, or Navigation health]
</Verification>
```

## Resources in this skill

| Topic | Reference |
|-------|-----------|
| Technical Writer Roadmap | [roadmap.sh/technical-writer](https://roadmap.sh/technical-writer) |
| Google Developer Style Guide | [developers.google.com/style](https://developers.google.com/style) |
| Microsoft Writing Style Guide | [learn.microsoft.com/en-us/style-guide](https://learn.microsoft.com/en-us/style-guide/) |
| Write the Docs Community | [writethedocs.org](https://www.writethedocs.org) |

## Quick example

**Strategy:** Implement a "Tutorial-first" IA to improve onboarding.

**Implementation:**
- `/getting-started`: 5-minute interactive guide.
- `/tutorials`: Task-based walkthroughs.
- `/api`: Exhaustive reference docs.
- `/concepts`: Deep dives into the "Why".

## Checklist before calling the skill done

- [ ] **Think Before Coding**: Information Architecture and user personas analyzed.
- [ ] **Simplicity First**: Simple Markdown and clear navigation used.
- [ ] **Surgical Changes**: Improved documentation by targeting specific gaps or errors.
- [ ] **Goal-Driven Execution**: Readability and technical accuracy verified.
- [ ] Docs-as-code workflow (GitHub/CI) implemented.
- [ ] Style guide (Google/Microsoft) consistently applied.
- [ ] API documentation generated from code/schemas (OpenAPI/Zod).