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
Analyze financial and operational data to uncover margin compression sources and revenue leakage points with precision. This skill helps you quantify the financial impact of each leak, size recovery opportunities, and prioritize actions that drive bottom-line improvement. You'll get a structured roadmap for profit recovery with clear metrics and timelines.
You can systematically diagnose electrical faults using structured troubleshooting frameworks, trace root causes with detailed analysis, and generate comprehensive maintenance plans with built-in code compliance checks. The skill verifies adherence to NEC, IEC, and local electrical codes while identifying safety risks and equipment impacts.
Analyze rental applications, credit reports, and tenant history to identify qualified candidates and flag potential risks. You can generate comprehensive risk assessments that help property managers and landlords make informed leasing decisions while staying compliant with fair housing practices. The skill evaluates financial stability, rental history patterns, employment verification needs, and behavioral indicators to score overall tenant suitability.
This skill automates tenant qualification by collecting and analyzing application data, income verification, credit metrics, and rental history to generate standardized risk scores and compliance-safe documentation. You can quickly assess tenant quality while maintaining fair housing compliance and creating audit trails for every decision. Standardize your tenant selection criteria across all properties and reduce manual review time significantly.
You provide your API specification (OpenAPI, Swagger, AsyncAPI, or raw specification), and this skill generates comprehensive, production-ready documentation including code examples, tutorials, integration guides, and troubleshooting sections. It transforms technical specifications into accessible developer guides that accelerate onboarding and reduce support questions.
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.
Generate legally compliant HOA violation notices tailored to your community's rules, complete with enforcement timelines and escalation options. Create de-escalation strategies for difficult resident interactions, prepare response templates for contentious situations, and develop communication plans that protect your HOA while maintaining positive community relationships.
Rapidly assess enterprise opportunity quality by scoring deal health, analyzing competitive positioning, and identifying win/loss patterns. You get a structured deal playbook with tailored positioning strategies, risk assessments, and objection counters customized to your specific competitive landscape and buyer dynamics.