The Challenge

With a growing platform and 170+ contributors, documentation standards were inconsistent. Different teams used different style guides, terminology, and formatting. This created a poor reader experience and made quality hard to maintain at scale.

The Solution

I led development and rollout of organization-wide documentation standards that became the baseline for all contributors across the engineering organization.

Key Components

Style Guide Created a comprehensive style guide based on Microsoft Style Guide with custom vocabulary for internal terminology.

Information Architecture Adopted and adapted the Diátaxis framework to structure all documentation consistently across tutorial, how-to, reference, and explanation content types.

Automation Implemented Vale linting to automatically enforce style rules on every pull request. This caught issues before human review.

Templates & Workflows Built reusable templates and contribution workflows that guided new contributors to produce consistent, high-quality documentation from their first PR.

Adoption & Training Conducted roadshows and provided company-wide guidance to help developers, product owners, and program managers adopt documentation best practices.

Impact

• Unified style and structure across 170+ contributors
• Reduced PR review cycles through automated linting
• Faster onboarding for new documentation contributors
• Improved reader experience through consistent terminology and structure

Tools & Technologies

Vale · GitHub Actions · Diátaxis · Markdown · Python