Technical Writer
Technical writers produce the content every IT professional reads. This path sharpens the English for SME interviews, documentation frameworks, API reference style, and changelog conventions.
Topics covered
- API docs language
- Diatáxis framework
- Docs-as-code
- SME interview English
- Changelog writing
Vocabulary spotlight
4 terms every Technical Writer should know in English:
Diatáxis n.
A documentation framework with four modes: tutorial, how-to guide, explanation, reference
"Our docs follow the Diatáxis framework — each page serves exactly one purpose."
SME n.
Subject Matter Expert — the specialist whose knowledge you are documenting
"I need 30 minutes with the SME to clarify the API error codes."
single-sourcing n.
Writing content once and publishing it in multiple formats or locations
"Single-sourcing keeps the SDK docs and web portal in sync automatically."
content reuse n.
Using the same content block in multiple documents without duplication
"The warning admonition is a content reuse block shared across 14 pages."
📚 Vocabulary Reference
Key terms organised by category for Technical Writers:
Documentation Types
Writing Style
Docs Tooling
Docs-as-Code
Content Strategy
Review Process
Developer Experience (DX)
Recommended exercises
Technical Writing Vocabulary
Vocabulary API Documentation Writing
Writing Changelog & Release Notes
Writing Rewrite Overly Complex Docs into Plain English
Writing Reading Technical Documentation
Reading Passive Voice vs Active Voice
Grammar Imperative Mood in Instructions
Grammar Writing API Endpoint Documentation
Writing Writing Technical Docs & READMEs
Writing Technical Writer Interview Questions
Interview Browse All Writing Exercises
Writing Real-world scenarios you'll practise
- Interviewing a developer to document a new API endpoint
- Writing a getting-started tutorial for a new SDK
- Structuring a changelog entry for a major version bump
- Reviewing documentation for technical accuracy and tone
- Interviewing a subject matter expert (SME) to extract technical details for documentation
- Giving feedback diplomatically on a developer's draft documentation
- Writing a deprecation notice — what's changing, the timeline, migration path, and call to action
- Structuring a tutorial from scratch using the Goals / Prerequisites / Steps / Next Steps pattern
- Writing a PR description for a documentation change
🎯 Interview questions specific to this role
Practise answering these questions out loud — or in writing. Each question targets a real interviewer concern for Technical Writers.
- Walk me through a piece of documentation you wrote from start to finish.
- How do you handle writing about a technology you do not fully understand yet?
- How do you measure the quality of your documentation?
- What is the difference between a tutorial and a how-to guide?
- How do you work with engineers who do not want to review docs?