6 articles tagged #technical-writing
All English for IT articles related to #technical-writing.
-
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.