73 articles tagged #technical-writing
All English for IT articles related to #technical-writing.
-
How to Decline a Vendor Proposal in English
Learn how to professionally decline a vendor's sales proposal or pitch after evaluation, in written English that's clear and final without being unnecessarily harsh or leaving the door ambiguously open.
-
How to Explain a Config Drift Issue in English
Learn how to explain in English that production configuration has drifted from its declared, infrastructure-as-code state — clearly enough for both engineers and non-technical stakeholders to understand the risk.
-
How to Explain a Deadlock in a Database in English
Learn how to explain a database deadlock incident — two transactions blocking each other — in clear English to a non-DBA audience, without either oversimplifying it or drowning them in jargon.
-
How to Explain a P99 Latency Regression in English
Learn how to explain in English that p99 latency regressed after a deploy, including what that metric actually means and how to connect the regression credibly to a specific cause.
-
How to Explain a Retry Storm Caused by a Client Bug in English
Learn how to explain, in English, an incident where a buggy client kept retrying aggressively and overwhelmed your service — clearly separating the client-side cause from the service-side impact.
-
How to Explain a Silent Data Corruption Bug in English
Learn how to explain, in clear English, a bug where data was silently corrupted without throwing any errors — and was only discovered much later, once the scope was already large.
-
How to Explain a Vendor Lock-In Concern in English
Learn how to raise a vendor lock-in concern in a design review in clear English — as a specific, actionable risk about a proposed choice, not a vague objection to using third-party services.
-
How to Give Feedback That Rejects a Design Doc in English
Learn how to reject or send back a technical design document in English — being direct about the concerns without being discouraging, and giving the author a clear path forward.
-
How to Justify a Refactor to a Skeptical Manager in English
Learn how to make the business case for a refactor in English to a manager who sees it as unnecessary work with no visible feature output — without resorting to vague appeals to 'code quality.'
-
How to Write a Blameless Incident Timeline in English
Learn how to write a factual, blame-free chronological timeline of an incident in English for a postmortem — precise enough to be useful, without implying individual fault.
-
How to Write a Risk Acceptance Memo in English
Learn how to formally document that your team is knowingly accepting a technical risk instead of fixing it, in clear English that satisfies stakeholders, auditors, and future you.
-
How to Write a Known Issues Section in Release Notes in English
Learn how to write a clear, honest known issues section in English release notes — describing the problem, its scope, and the workaround without undermining confidence in the release.
-
How to Write a Penetration Test Findings Summary in English
Learn the English vocabulary and structure needed to summarize penetration test findings clearly for both engineering teams and non-technical stakeholders.
-
How to Write a Root Cause Analysis Report in English
Learn the English vocabulary and structure needed to write a clear, blameless root cause analysis report after a technical incident.
-
English for Vale Prose Linting
Learn the English vocabulary for Vale, the prose linter for technical writing: styles, vocab rules, and severity levels, explained clearly.
-
How to Announce a Service Deprecation Timeline in English
Learn the English structure for announcing a service or API deprecation timeline clearly: sunset date, migration path, and support boundaries.
-
How to Communicate a Dependency Vulnerability in English
Learn the English structure for reporting and communicating a vulnerable dependency: severity, exposure, and the patch timeline, without causing panic or complacency.
-
How to Discuss API Versioning Strategy in English
Learn the English vocabulary for discussing API versioning strategy: breaking changes, deprecation windows, and version negotiation with stakeholders.
-
How to Discuss Database Index Tuning in English
Learn the English vocabulary for discussing database index tuning: query plans, selectivity, and the trade-offs between read and write performance.
-
How to Explain a Cache Invalidation Bug in English
Learn the English phrases for explaining a cache invalidation bug: describing the stale-data symptom, the missed invalidation, and the fix, clearly and precisely.
-
How to Explain a Certificate Expiry Incident in English
Learn how to write a clear postmortem and customer-facing explanation in English when a TLS/SSL certificate expiry causes an outage, including how to describe prevention steps credibly.
-
How to Explain a Flaky Test Quarantine Policy in English
Learn the English phrases for proposing, explaining, and enforcing a flaky test quarantine policy with a team, without it becoming a place tests go to be forgotten.
-
How to Explain a Memory Leak in English
Learn the English phrases for describing a memory leak: naming what's being retained, the growth pattern, and the fix, for both engineers and stakeholders.
-
How to Explain a Race Condition in English
Learn the English phrases for explaining a race condition to teammates and stakeholders: describing the timing dependency, its impact, and the fix clearly.
-
How to Give Feedback on an RFC in English
Learn the English phrases for reviewing an RFC: distinguishing blocking concerns from suggestions, asking clarifying questions, and signing off clearly.
-
How to Give Feedback on Documentation in English
Learn the English phrases for reviewing technical documentation: flagging gaps, unclear instructions, and outdated content constructively.
-
How to Leave a Thorough Design Doc Review Comment in English
Learn the English phrases for reviewing a technical design document thoroughly: questioning assumptions, flagging risks, and proposing alternatives.
-
How to Request a Design Review in English
Learn the English phrases for requesting a technical design review: framing the ask, stating what feedback you need, and setting a clear deadline.
-
How to Request a Security Exception in English
Learn the English structure for requesting a security policy exception: justification, scope, compensating controls, and the expiration date.
-
How to Write a Canary Release Report in English
Learn the English structure and vocabulary for writing a canary release report: metrics tracked, rollout decision, and the promote-or-rollback call.
-
How to Write a Changelog Entry in English
Learn the English vocabulary and conventions for writing clear, user-facing changelog entries for features, fixes, and breaking changes.
-
How to Write a Cost Anomaly Report in English
Learn the English structure for reporting an unexpected cloud cost spike: the anomaly, the root cause, and the remediation, written for both engineers and finance.
-
How to Write a Database Rollback Plan in English
Learn the English structure and vocabulary for writing a clear database migration rollback plan that a reviewer can approve with confidence.
-
How to Write a Deprecation Notice Email in English
Learn the English structure and phrasing for writing a clear deprecation notice email that gives users enough information and time to migrate.
-
How to Write a Design Doc Alternatives Section in English
Learn the English vocabulary and structure for writing a strong alternatives-considered section in a technical design document, including how to fairly compare rejected approaches.
-
How to Write a Design Doc Problem Statement in English
Learn the English structure and phrasing for writing a clear, specific problem statement at the start of a technical design document.
-
How to Write a Handover Document in English
Learn the English structure and phrases for writing a handover document: context, current state, open items, and contacts, for a clean transition.
-
How to Write a Migration Runbook in English
Learn the English structure and vocabulary for writing a database or system migration runbook: pre-checks, execution steps, and the rollback plan.
-
How to Write a Risk Register Entry in English
Learn the English structure and vocabulary for writing a clear project risk register entry: likelihood, impact, mitigation, and ownership.
-
How to Write a Technical Blog Comment Response in English
Learn how to respond to technical blog comments in English: correcting errors gracefully, handling disagreement, and answering follow-up questions.
-
How to Write a Technical Interview Feedback Form in English
Learn the English structure for writing technical interview feedback that's specific, defensible, and useful for a hiring committee decision.
-
How to Write an RFC Comment Thread Summary in English
Learn the English structure and vocabulary for summarizing a long RFC comment thread: the disagreement, the resolution, and what changed in the doc.
-
How to Explain Technical Debt to a Non-Technical Manager in English
Learn the English phrases for explaining technical debt to a non-technical manager in terms of business risk and cost, not code quality.
-
How to Explain a Third-Party Vendor Outage to Customers in English
Learn how to communicate a service disruption in English when the root cause is a third-party vendor outage — being transparent without shifting blame or sounding evasive.
-
How to Lead an RFC Discussion in English
Learn the English phrases for facilitating a technical RFC discussion: framing trade-offs, managing disagreement, and driving toward a decision.
-
How to Write an API Versioning Announcement in English
Learn how to announce a new API version in English — explaining what's new, the deprecation timeline for the old version, and clear migration steps for integrating developers.
-
How to Announce an API Rate Limit Change in English
Learn how to write a clear, professional announcement when changing API rate limits — communicating new thresholds, the reasoning, and migration guidance to developer customers.
-
How to Propose a Tech Radar Entry in English
Learn how to write and present a technology radar entry in English — recommending a tool or pattern be adopted, trialed, held, or retired, with clear reasoning your team can act on.
-
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 a Bug Bounty Report in English
A practical English guide for writing clear, well-structured bug bounty and vulnerability reports that get triaged quickly and taken seriously by security teams.
-
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.
Frequently Asked Questions
How many articles are tagged #technical-writing?
There are currently 73 articles tagged #technical-writing on CoderSlingo.
What is the #technical-writing tag about?
The #technical-writing tag groups together CoderSlingo articles that discuss technical writing — useful if you want to read everything on this topic in one place.
Is browsing tagged articles free?
Yes. Every article on CoderSlingo, including all articles tagged here, is free to read with no account, sign-up, or paywall.
How often is this tag page updated?
This page is regenerated automatically whenever a new article is published with this tag, so the list always reflects the latest content.
What's the difference between a tag and a category?
A category is the single primary topic of an article (shown as a badge on each card), while tags are more specific keywords an article can have several of — useful for cross-cutting topics like tools or techniques.
Can I find beginner-friendly articles under this tag?
Yes — each article card shows a level badge (Beginner, Intermediate, or Advanced) so you can quickly spot content that matches your current English level.
How do I browse other tags?
Click any tag pill on an article card to jump to that tag's page, or visit the main Blog index to browse by category instead.
Are these articles connected to exercises?
Many are — articles link to a relevant vocabulary exercise in their "What to Read Next" section so you can practise the terms you just read about.
What's the most recent article tagged #technical-writing?
The most recent article tagged #technical-writing is "How to Decline a Vendor Proposal in English".
Where can I see all articles, not just this tag?
Visit the main Blog index to browse every CoderSlingo article, filterable by category, level, and tag.