Documentation Engineer
Documentation Engineers own the systems and standards that make technical knowledge accessible to developers. Their English must be exceptionally clear: they write contribution guidelines, define information architecture, and craft tutorials and reference pages that serve global audiences. This path covers the language of content strategy, structured authoring, and developer-experience writing.
Topics covered
- Docs-as-Code Workflow
- Diataxis Framework
- Information Architecture
- Contribution Guides & Style
- API Reference Writing
- Content Strategy for Developers
Vocabulary spotlight
4 terms every Documentation Engineer should know in English:
A documentation framework that organises content into four distinct types: tutorials, how-to guides, explanations, and reference material
"After adopting Diataxis, the team separated tutorial content from reference pages and reduced user confusion."
A philosophy and practice of writing and managing documentation using the same tools and workflows as software — version control, pull requests, and CI/CD
"With a docs-as-code approach, every documentation change is reviewed in a pull request before it is published."
The structural design of a documentation set, defining how content is organised, labelled, and navigated
"Improving the information architecture reduced the average time users spent finding the correct API reference."
Describing content that remains accurate and useful over time without requiring frequent updates
"Conceptual explanations are more evergreen than release notes and should be written to stay relevant across versions."
📚 Vocabulary Reference
Key terms organised by category for Documentation Engineers:
Diataxis Content Types
Docs Workflow & Tooling
Information Architecture
Writing & Style
Recommended exercises
Real-world scenarios you'll practise
- Writing a contribution guide that helps external developers submit high-quality documentation pull requests.
- Restructuring an existing docs site using the Diataxis framework and presenting the rationale to the team.
- Reviewing a developer tutorial draft and providing constructive written feedback on clarity and structure.
- Defining a style guide entry for a contested terminology choice affecting multiple product teams.