52 articles tagged #documentation
All English for IT articles related to #documentation.
-
Knowledge Management English for Engineering Teams
Explore the English vocabulary engineering teams use to document knowledge — runbooks, postmortems, ADRs, and more.
-
How to Write a Technical Onboarding Checklist in English
A practical English guide for writing developer onboarding checklists — clear task phrasing, structuring by week, and writing for a global new hire.
-
How to Write a Technical Content Strategy in English
Learn professional English vocabulary and phrases for writing a technical content strategy — audits, content types, editorial calendars, and measuring impact.
-
How to Write Technical Runbooks in English
Learn the English vocabulary and writing patterns for clear, professional technical runbooks used in SRE and operations teams.
-
How to Read and Understand Technical Documentation Faster
Practical strategies for reading technical documentation in English more efficiently — skimming, scanning, handling jargon, and building comprehension for API docs and specs.
-
How to Write a Post-Mortem Report in English
Learn the structure, language, and blameless tone for writing a post-mortem report in English — incident timeline, root cause, contributing factors, and action items.
-
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.
-
How to Write Clear API Error Messages in English
Learn how to write API error messages that are clear, actionable, and developer-friendly — with English writing principles, real examples, and common anti-patterns to avoid.
-
Engineering Offboarding in English: Knowledge Transfer and Handover Language
Learn the English vocabulary for engineering offboarding — knowledge transfer, bus factor, runbook handover, codebase tours, and documentation debt.
-
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.
-
How to Write Technical RFCs: Advanced Language Guide
Master the advanced English writing skills needed to produce compelling, well-structured technical RFCs that drive alignment and good decision-making in engineering teams.
-
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.
-
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.
-
Writing Contract-First API Design Documents in English
Develop the English writing skills needed to produce clear, professional contract-first API design documents that engineers and stakeholders can act on.
-
Writing SDK Documentation in English
Develop the skills to write clear, professional SDK documentation in English — from getting started guides to API references and code examples.
-
Professional English for API Documentation: Style, Register, and Structure
How to write API documentation in professional English — covering reference docs vs guides, consistent verb tense, parameter descriptions, and endpoint documentation examples.
-
Writing RFC and ADR Documents in English
How to write technically precise RFCs and Architecture Decision Records using RFC 2119 obligation language, formal structure vocabulary, and professional prose.
-
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.
-
How to Explain an Architecture Decision in English
How to write and present Architecture Decision Records (ADRs) in English: structure, trade-off language, 'we chose X over Y because', and decision documentation phrases.
-
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 Write a Technical Specification in English
Structure and language for technical specifications: functional vs non-functional requirements, 'shall' vs 'should', spec document sections, and writing with precision.
-
How to Write an Architecture Decision Record (ADR)
Learn the ADR structure: context, decision, consequences. Includes a full example template, common mistakes to avoid, and phrases for writing clear ADRs in English.
-
How to Write an Engineering Design Document
Structure and English language for writing clear engineering design documents — problem statement, proposed solution, alternatives considered, and open questions.
-
How to Write an SRE Runbook in English
Runbook structure, clear imperative instructions, decision trees, and troubleshooting language — a practical guide to writing SRE runbooks in English.
-
How to Write Technical Release Notes
Learn how to write clear technical release notes: breaking changes, added/changed/fixed/removed sections, versioning, audience, and examples from Stripe and GitHub.
-
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.
-
English for Terraform Cloud Teams: Plans, Modules, and Variable Descriptions
Learn to write clear Terraform plans, module documentation, and variable descriptions in English — practical writing patterns for cloud engineers.
-
Grammar for Conditional Sentences in Tech Docs: If, When and Unless
Master conditional sentences in technical documentation — if vs when vs unless, the zero conditional, real vs hypothetical conditions — with examples and common mistakes.
-
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.
-
Writing Architecture Decision Records: Advanced Language and Structure
Go beyond the ADR template: master the advanced English of context, trade-offs, consequences, and status language so your architecture decision records read with authority.
-
Writing Changelog Entries in English: Clear, Scannable Release Notes
Write changelog entries that users actually read — clear verbs, consistent categories, user-facing language and breaking-change notices — with templates and before/after examples.
-
Writing Clear Pull Request Descriptions in English
A practical guide to writing clear pull request descriptions in English: structure, phrasing, verb tense, and before/after examples that get your PRs reviewed faster.
-
Writing Effective Commit Messages: Advanced English and Conventional Commits
Go beyond basic commit messages — learn Conventional Commits format, semantic meaning, linking issues, and the English writing patterns that make git history truly useful.
-
Writing Runbook Documentation in English: Clear, Action-Ready Steps
Learn to write runbook documentation in English that works under pressure: imperative steps, precise verbs, decision points, and before/after rewrites for clarity.
-
Writing Advanced System Design Documents in English
Master the language of advanced system design docs: trade-off framing, back-of-envelope estimation, and design decision vocabulary for senior engineers.
-
Writing Technical Design Documents in English: Structure and Language
Learn to write clear technical design documents in English: structure, the goals/non-goals pattern, proposing solutions, weighing trade-offs, and the right tense and voice.
-
How to Write a Game Design Document (GDD) in English
A complete guide for game developers: how to write a professional Game Design Document — structure, vocabulary, key sections, and English phrases for GDD writing.
-
The Diataxis Framework Explained: Four Types of Documentation
Understand the Diataxis framework for technical documentation — tutorials, how-to guides, explanations, and reference — with vocabulary and example sentences for documentation engineers.
-
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.
-
How to Write a Data Contract in English
A complete guide for data engineers: what a data contract is, how to write one in English, the required sections, vocabulary, and ready-to-use templates.
-
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.
-
Model Card Writing Guide for ML Engineers
Learn how to write a professional model card in English — structure, required sections, evaluation reporting, and ready-to-use phrases for documenting AI models.
-
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.
-
Reading API Documentation in English: A Practice Guide
Learn to navigate API documentation efficiently. Covers endpoint descriptions, parameters, response schemas, error codes, and the standard vocabulary of REST and GraphQL docs.
-
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.
-
How to Write App Store Release Notes That Users Actually Read
Learn how to write clear, engaging App Store and Google Play release notes in English. Real templates, common mistakes, and examples from top apps.
-
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.
-
How to Write an Architecture Decision Record (ADR) in English
A practical guide to writing clear, professional Architecture Decision Records in English: structure, vocabulary, example templates, and the phrases that experienced architects use.
-
How to Write an Integration Design Document in English
Learn the structure and vocabulary for writing professional integration design documents in English, including data flow, field mapping, and error handling.
-
Git Commit Messages: Best Practices and English Tips
How to write clear, consistent, professional git commit messages in English — with the Conventional Commits format, real examples, and the most common mistakes to avoid.