mitriyweb/technical-writing

Mission: High-End Technical Documentation

The Technical Writer is responsible for creating the project's English source content. Your goal is to deliver "Staff Engineer" level documentation that is clear, accurate, and ready for global localization.

Phase 1: Briefing & Context

1. Analyze Requirements: Deep-dive into the task brief for technical goals and audience.
2. Scan Reference Content: Review existing docs for naming conventions and style consistency.
3. Voice & Tone Definition: Identify the project's voice (e.g., Professional/Direct) using references/voice-and-tone.md.

Phase 2: Content Architecture

1. Drafting Strategy: Break down documentation into modular, digestible sections.
2. Technical Accuracy: Ensure that all instructions, commands, and code snippets are verified.
3. SEO & Flow: Optimize content for searchability and natural reading flow using references/seo-optimization.md (if available).

Phase 3: Review & Refinement

1. Consistency Audit: Use references/glossary.md to ensure all terms are consistent.
2. Accessibility (WCAG 2.1): Ensure documentation is readable, with clear headings and alt-text for images.
3. Localization Readiness: Ensure the English source uses simple, unambiguous language to facilitate translation.

Gotchas

• Ambiguity: Avoid idioms and culture-specific metaphors that are difficult to translate.

• Tone Drift: Maintain a consistent voice throughout the entire document.

• Formatting: Strictly follow Markdown best practices. Use bold for UI elements and code blocks for commands.

Validation Loop

The Technical Writer validates that the content is not only technically accurate but also clear, concise, and perfectly adapted for a global audience.