Everything for Technical Writers
Technical writers are the one role whose entire job is English quality — style guides, plain-language principles, and SME interviews. This hub gathers the documentation-focused vocabulary, the most relevant grammar drills, and every interview and blog resource tagged writing or documentation.
Vocabulary sets
Grammar & writing
Interview prep
Blog articles (16)
- API Deprecation English: Communicating Breaking Changes to Developers
Learn the English vocabulary and phrases for deprecating APIs — sunset dates, migration guides, breaking changes, and developer communication explained.
- Architecture Review English: Leading and Participating in Design Reviews
Master the vocabulary and phrases for architecture reviews — opening a review, raising concerns diplomatically, asking questions, and documenting decisions.
- Submitting Conference Talks: Writing Abstracts in English
Learn how to write a compelling conference talk abstract in English — CFP structure, hook sentences, bio writing, and key vocabulary for speaker submissions.
- Documentation Review English: Phrases for Reviewing and Approving Docs
Learn the English phrases used when reviewing technical documentation — feedback language, approval phrases, and vocabulary for improving clarity and accuracy.
- Engineering Manager English: 1:1s, Performance, and Team Communication
Learn the English vocabulary for engineering managers — 1:1 meetings, performance reviews, career ladders, feedback phrases, and team health vocabulary.
- Navigating Engineering Reorgs: English for Organisational Changes
Learn the English vocabulary for navigating engineering reorganisations — reporting lines, headcount, span of control, and communication phrases explained.
- Writing Feature Specifications in English: Structure and Vocabulary
Learn the vocabulary and structure for writing feature specifications — acceptance criteria, scope, assumptions, edge cases, and success metrics.
- How to Give Technical Feedback in English: Phrasing and Collocations
Learn constructive feedback phrases for code reviews and technical discussions — softening language, blocking vs non-blocking comments, and real examples.
- Knowledge Transfer English: Phrases for Handoffs and Documentation
Learn the English vocabulary and phrases for knowledge transfer — handoff documents, runbooks, tribal knowledge, bus factor, and onboarding terms explained.
- On-Call Handoff English: Phrases for Shift Transitions
Learn the vocabulary and phrases for on-call handoffs — verbal and written shift transitions, what to include, what to flag urgently, and handoff templates.
- Post-Incident Report English: Writing Effective Postmortems
Learn postmortem vocabulary and writing style — blameless language, precise timeline writing, root cause analysis, and corrective action ownership.
- Release Notes English: Writing Changelogs and Communicating Changes
Learn the English vocabulary and writing patterns for release notes and changelogs — added, fixed, changed, breaking changes, and communication phrases explained.
Showing the 12 most recent of 16 matching posts. Browse the full blog archive for the rest.
Other role hubs
Explore more
Browse every exercise category, or search the full site.
Frequently Asked Questions
What's the difference between 'documentation' and 'technical writing'? I see both terms used.
While often overlapping, 'documentation' is a broader term referring to any information created to explain a product or system. 'Technical Writing,' specifically, focuses on creating clear, concise, and accurate instructions, guides, and manuals for technical audiences – typically developers and users. Think of documentation as the umbrella, and technical writing as a specialized skill within that umbrella.
I'm asked to create 'API documentation'. What does that actually mean?
'API Documentation' describes how to use an Application Programming Interface (API). It typically includes function signatures, parameters, return values, and example code snippets demonstrating common usage. The goal is for developers to quickly understand and integrate the API into their own applications.
What's a 'style guide' and why is it important for technical writing?
A style guide establishes consistent formatting, terminology, and voice within all documentation. This ensures uniformity, readability, and reduces ambiguity for the reader. Common style guides include Microsoft Manual Style or Google Developer Documentation Style, tailored to specific product types.
I need to write about a 'design document' – what kind of information should I include?
A design document outlines the architecture and technical specifications for a software project. It usually details components, interfaces, data flow, algorithms, and potential challenges—essentially, it's a blueprint for development. Including diagrams and wireframes is often crucial.
What's meant by 'single-source documentation' and how does it help?
'Single-Source Documentation' refers to creating content once and reusing it across multiple formats (e.g., web, PDF, print). This dramatically reduces redundancy, streamlines updates, and ensures consistency across all platforms. Tools like DITA or Markdown are commonly used for this approach.
Explain 'content modeling' in the context of technical writing – what does it involve?
Content Modeling is the process of organizing and structuring information to meet specific audience needs. It involves identifying content types, relationships between them, and defining metadata (tags or attributes) to enable efficient searchability and reuse. Think of it as creating a 'data skeleton' for your documentation.
I'm writing about 'user flows'. What are they?
'User Flows' visually represent the steps a user takes to complete a task within a software application or system. They typically include screens, actions, and decision points, illustrating the entire process from start to finish. This helps developers understand how users interact with the product.
What's 'information architecture' and why does it matter for technical writers?
Information Architecture (IA) is about organizing, structuring, and labeling content to help users find what they need efficiently. For technical writers, IA involves designing the logical structure of documentation – headings, navigation, search functionality—to optimize user experience and comprehension.
What's a 'release note' and its purpose?
Release notes document changes introduced in a software release, including new features, bug fixes, and known issues. They are primarily intended for users to understand the impact of the update on their existing workflows and inform them about any necessary adjustments or considerations.
I'm asked to create 'help files'. What's the difference from a user manual?
'Help Files' are typically context-sensitive documentation embedded directly within an application, offering immediate assistance based on the user's current activity. User manuals, conversely, provide more comprehensive instructions for using the entire product or system – think of help files as quick tips and user manuals as detailed guides.