11 articles tagged #documentation
All English for IT articles related to #documentation.
-
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.
-
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.
-
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.
-
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.
-
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.