24 articles tagged #technical-writing
All English for IT articles related to #technical-writing.
-
How to Write a Technical RFC in English
Learn how to write a clear, persuasive Request for Comments (RFC) in English — structure, tone, key phrases, and common pitfalls for senior developers.
-
Grammar: Conditionals in Technical Analysis
How to use conditional structures to analyse trade-offs, describe system behaviour, and discuss hypotheticals in technical English writing and conversations.
-
Grammar: Gerunds vs Infinitives in Technical Writing
When to use 'monitoring the system' versus 'to monitor the system' in technical documentation — a practical grammar guide for IT professionals.
-
Grammar: Hedging Language in Technical Proposals
How to use hedging in technical English: 'it appears that', 'we estimate', 'subject to', expressing uncertainty professionally in proposals, reports, and designs.
-
How to Use Active Voice in Technical Documentation
Why active voice makes technical documentation clearer, faster to read, and easier to act on — with real IT examples and before-and-after rewrites.
-
How to Use Hedging Language in Technical English
Learn how to express uncertainty professionally in English using hedging language: might, could indicate, it appears, preliminary results suggest, and more.
-
Using Passive Voice in Technical Documentation
When to use passive voice in API docs, changelogs, and postmortems — and when to avoid it. Practical examples and grammar guidance for technical writers.
-
Grammar: Modal Verbs for Expressing Technical Uncertainty
How to use modal verbs correctly when discussing uncertain technical situations — estimates, risks, possibilities, and recommendations in professional English.
-
Grammar: Passive Voice in Technical Documentation
When and how to use the passive voice in technical writing — with examples from real documentation, API references, and incident reports.
-
How to Write a Clear Incident Post-Mortem
A practical guide to writing effective incident post-mortems in English — structure, language, blameless framing, and phrases that communicate clearly.
-
How to Write a Compelling Technical RFC
A practical guide to writing technical RFCs (Request for Comments) in English — structure, vocabulary, and phrases that get your proposals approved.
-
How to Write API Documentation in English
A practical guide to writing clear, professional API documentation in English — reference docs, guides, error messages, and the language patterns developers expect.
-
Writing Technical Whitepapers in English: Structure and Language Guide
Whitepaper structure, executive summary, problem statement, methodology, and professional English for technical whitepapers.
-
How to Write a Technical RFC in English: Structure and Phrases
RFC (Request for Comments) structure, problem statement, proposed solution, alternatives, and decision vocabulary in English.
-
English for Technical Documentation: Writing for Global Developer Audiences
Practical guidance for writing technical documentation in English — plain language principles, active vs passive voice, British vs American English choices, and inclusive language for global developer audiences.
-
Writing Performance Analysis Reports: Structure and Vocabulary
Learn to write clear performance analysis reports in English: executive summary, methodology, findings, recommendations, numbers and units vocabulary, and hedging language.
-
English Style Guides for Developer Documentation: What Every Tech Writer Should Know
Compare Google, Microsoft, and Apple developer documentation style guides: active voice, second person, inclusive language, and before/after style correction examples.
-
Architecture Decision Records in English: Structure, Language, and Templates
Learn how to write Architecture Decision Records in clear English: ADR structure, vocabulary for each section, hedging language for trade-offs, and ready-to-use templates.
-
English for Security Engineers: CVE Advisories and Vulnerability Reports
The English vocabulary and writing skills security engineers need for CVE advisories, vulnerability disclosures, security reports, penetration test findings, and incident communications. Templates and real examples.
-
English for Solution Architects: Trade-Off Language and Design Reviews
How solution architects communicate in English — documenting trade-offs, presenting architecture decisions, running design reviews, and writing ADRs. The specific vocabulary and phrases for architecture communication.
-
The 4 Types of Documentation: Diátaxis Framework Explained
Learn the Diátaxis framework for technical documentation — the 4 types: tutorials, how-to guides, reference, and explanation. With examples, templates, and common pitfalls for technical writers and developers.
-
Active vs. Passive Voice in Technical Writing: When to Use Each
When to use active and passive voice in technical documentation, API docs, commit messages, and error messages. Rules, examples, and a quick test to decide which voice to use.
-
Modal Verbs in Technical Writing: Must, Should, May, Might
How to use modal verbs correctly in API documentation, runbooks, and technical specifications. When to write MUST vs SHOULD vs MAY, and how to avoid the most common modal verb mistakes in technical English.
-
Writing API Documentation in English: Templates and Examples
How to write clear, professional API documentation in English. Templates for endpoints, parameters, error codes, and SDK guides — with real examples.