Technical Documentation Writer
Generate professional API, SDK, and system documentation following Google's style guide
What You Can Do
You can transform technical specifications and code into production-ready documentation that serves developers at all experience levels. Claude structures content hierarchically, includes runnable code examples, defines prerequisites clearly, and reduces support burden by anticipating common integration questions. The skill applies Google's proven documentation patterns to ensure consistency, searchability, and usability across API references, quickstart guides, SDK documentation, and operational runbooks.
Features
Automatically scaffolds content for beginner, intermediate, and advanced developer personas within a single document
Produces syntactically correct, runnable examples in multiple languages with context-appropriate complexity
Structures endpoint documentation with consistent parameter descriptions, response codes, error handling, and authentication requirements
Generates hierarchical documentation architecture with jump links, breadcrumbs, and predictable section ordering
Explains system design, data models, workflows, and architecture decisions in developer-friendly language with diagrams and flow descriptions
Identifies and clearly communicates dependencies, version requirements, API keys, environment setup, and installation steps upfront
Applies voice, tone, terminology, and formatting standards from Google's technical writing best practices
Documents breaking changes, upgrade paths, and legacy API transitions with clear timelines and alternatives
Example Output
API Reference Example:
## POST /v2/users
Creates a new user in the system.
### Authentication
Requires Bearer token in Authorization header.
### Request Body
- `email` (string, required): User email address
- `role` (enum, optional): 'admin', 'editor', 'viewer'. Defaults to 'viewer'
### Response
200 OK
```json
{
"id": "usr_123abc",
"email": "user@example.com",
"role": "viewer",
"created_at": "2024-01-15T10:30:00Z"
}
Error Responses
400 Bad Request: Invalid email format409 Conflict: Email already exists401 Unauthorized: Missing or invalid token
**Quickstart Example:**
Getting Started with the SDK (5 minutes)
Prerequisites
- Node.js 16+
- npm or yarn
- API key from your dashboard
Installation
```bash npm install @company/sdk ```
Your First Request
```javascript const SDK = require('@company/sdk'); const client = new SDK.Client({ apiKey: process.env.API_KEY });
const user = await client.users.create({ email: 'dev@example.com', role: 'editor' }); console.log('User created:', user.id); ```
What's Included
- SKILL.md instruction file: Complete system prompt for Claude's documentation generation behavior
- API Reference Template: Standardized structure for endpoint documentation (parameters, responses, errors, examples)
- SDK Quickstart Checklist: Prerequisites, installation, authentication, and first-request scaffolding
- Google Style Guide Compliance Checklist: Voice, tone, terminology, formatting, and structural standards
- Content Hierarchy Framework: Multi-level audience segmentation (beginner/intermediate/advanced) and progressive disclosure patterns
Who It's For
- Developer advocates and developer relations teams — Creating SDK guides and integration documentation that accelerates adoption
- Backend and infrastructure engineers — Documenting microservices, APIs, data pipelines, and internal system runbooks
- Technical product managers — Generating API reference docs and feature documentation for developer-facing products
- Solutions architects — Building integration guides and operational documentation for client implementations
- Documentation specialists — Maintaining consistent technical documentation across multiple platforms and products
Best For
- API reference documentation — Endpoint definitions, parameter specs, response schemas, error codes
- SDK and library guides — Installation, authentication, quickstarts, and language-specific examples
- Conceptual and architectural documentation — System design, data models, workflows, and decision rationale
- Integration and migration guides — Third-party integrations, upgrade paths, breaking changes, deprecation notices
- Operational runbooks — Internal system documentation, troubleshooting guides, and maintenance procedures
You might also like
Plan preventive maintenance schedules, prioritize work orders by urgency and impact, forecast maintenance budgets with cost predictions, and generate compliance documentation for audits. You'll reduce downtime, extend asset lifecycles, and maintain regulatory compliance across your entire facilities portfolio.
You can input symptoms and system details from your HVAC equipment, and receive a structured diagnosis identifying root causes, severity levels, and recommended repair priorities. The skill generates visual troubleshooting flowcharts, safety warnings, and actionable next steps tailored to commercial or residential systems. You'll get data-driven recommendations that help you make faster, more accurate repair decisions and avoid costly misdiagnosis.
Systematically analyze HVAC and mechanical system failures by examining equipment data, maintenance history, and performance trends. You'll generate detailed diagnostic reports that identify root causes, create preventive maintenance schedules tailored to your building's specific equipment and usage patterns, and uncover efficiency gains worth thousands in annual energy savings. The skill helps you make data-driven decisions on equipment replacement, prioritize maintenance tasks, and maintain compliance documentation.
You can diagnose electrical system faults in buildings using a structured, safety-first diagnostic protocol. Claude guides you through systematic fault identification, root cause analysis, and compliant remediation planning for circuits, equipment, and building systems. Whether you're troubleshooting a tripped breaker, equipment failure, or safety hazard, you get a documented diagnostic pathway with verified findings and next steps.
You'll transform your portfolio from a showcase into a strategic lead-generation machine that attracts higher-paying clients automatically. Using psychological positioning and case-driven storytelling, you'll increase visitor-to-inquiry conversion by 3-5x and command premium pricing. Claire gets qualified leads without cold outreach, and so can you.
This skill analyzes financial allocations across diverse categories—real estate, departments, asset types—and reconciles them against assessments, audits, or performance metrics. You can identify allocation gaps, validate spending against strategic assessments, and generate reconciliation reports that explain variances and recommend rebalancing. It handles complex multi-category scenarios where traditional single-asset allocation tools fall short.
Create comprehensive preventive maintenance schedules, prioritize work orders by criticality and impact, forecast capital expenditure budgets, and generate compliance documentation for your entire building portfolio. You can analyze maintenance patterns, identify cost-saving opportunities, and ensure regulatory requirements are met across all properties.
Systematically document, analyze, and resolve conflicts between residential and commercial tenants in mixed-use properties. This skill provides templated mediation frameworks, escalation protocols, and legal compliance checks to help you navigate disputes while maintaining positive community relationships. You'll generate customized resolution strategies based on dispute type, severity, and applicable regulations.