technical-writer

Structure technical documentation by organizing content hierarchically with standardized article layouts, descriptive headings, and constrained navigation depth. Apply consistent formatting conventions for code blocks, UI elements, and links across READMEs, API docs, guides, and release notes to improve readability and user navigation.

API documentation should use sentence case for headings, descriptive link text, ALL-CAPS placeholders for variables, and organized parameter tables with examples. Structure content procedurally, align with your project's style guide, and ensure code formatting is consistent across all reference materials.

Review your README for clear information architecture, proper Markdown formatting, descriptive navigation, and accessibility compliance. Apply standardized structure, verify code examples are accurate, use constrained heading depth, and align content with your project's documentation style conventions.

Yes. Technical documentation guidance applies across content types including guides, tutorials, quickstarts, specifications, and release notes. Each type benefits from consistent structure, style alignment, proper code formatting, and procedural content ordering to meet functional and technical requirements.

Unclear documentation often lacks consistent structure, uses inconsistent formatting, has poor information hierarchy, or misaligns with style guides. Apply expert guidance on content architecture, standardized article structures, proper heading depth, descriptive link text, and accessibility best practices to resolve these issues.

Markdown familiarity is helpful since this guidance applies to Markdown-based docs in docs/ directories and README files. However, the core principles—structure, style consistency, accessibility, and procedural ordering—apply universally across documentation formats and tools.