technical-writer

The Diataxis framework structures developer documentation by categorizing content into tutorials, how-to guides, reference material, and explanations. This approach separates learning from doing, ensuring users find the right information based on their specific needs.

To write consistent API docs and READMEs across projects, apply standardized versioned templates and enforce strict style guidelines. This unifies terminology and formatting, reducing fragmentation and improving overall developer productivity.

Glossary management improves technical writing by enforcing consistent terminology and definitions across onboarding materials. This prevents confusion and ensures new developers understand project-specific concepts uniformly throughout all documentation.

Yes, you can outline API references for a new module and simultaneously generate matching tutorials, how-to guides, and explanations. This creates comprehensive documentation that serves diverse project needs from a single structured workflow.

Contributor guidance provides best practices for documentation collaboration, review, and maintenance. It establishes clear workflows for updating versioned templates and keeping onboarding materials accurate over time.

Use an Architecture Decision Record (ADR) template when you need to document significant technical decisions, constraints, and context. ADRs provide a structured format to record why a specific approach was chosen for future reference.