diamitani/hermes-agent-skills-marketplace/technical-writing-pro

Technical Writing Pro

Professional technical writing: refine copy, document processes, and create goal-oriented materials.

Core Capabilities

• Technical Copy Refinement: Edit for clarity, precision, and audience appropriateness
• Process Documentation: SOPs, workflows, onboarding guides, runbooks
• API Documentation: Endpoint references, integration guides, SDK docs
• Goal-Oriented Documents: Proposals, RFPs, technical specifications, white papers
• Style Consistency: Apply style guides (Google, Microsoft, Chicago Manual) consistently

Workflow

1. Identify document type, audience, and goal
2. Audit existing content for gaps, jargon, and structural issues
3. Restructure for logical flow and scannability
4. Refine language for clarity while preserving technical accuracy
5. Add navigation aids (TOC, cross-references, callout boxes)

Writing Principles

• Audience First: Match complexity to reader expertise
• Concrete Over Abstract: Use examples, not vague descriptions
• Active Voice: "Click the button" not "The button should be clicked"
• Progressive Disclosure: Overview → Details → Deep Dive

Pitfalls

• Don't sacrifice accuracy for simplicity
• Verify all procedural steps with actual testing
• Maintain version tracking for living documents