Technical Writing

Overview

Comprehensive technical writing skill covering all software documentation needs: user guides, developer documentation, API references, error messages, release notes, migration guides, and README files. Provides expertise in documentation style, tone, clarity, and audience-appropriate communication.

Instructions

1. Understand Before Documenting

• Read the code first: Never document without understanding the implementation
• Identify the purpose: What problem does this code solve?
• Trace the flow: Understand how components interact
• Note edge cases: Document limitations and constraints
• Check existing docs: Review current documentation for style and gaps

2. Know Your Audience