Tag: #technical-writing
Writing on GPUs, LLMs, MLOps, Kubernetes — and mindset · 13 posts
13 posts are tagged #technical-writing; the most recent was published on 2026-08-15.
Often tagged together: #2026-03 9 #english 7 #adr 6 #documentation 6 #rfc 5
Most read in the last 90 days:
Writing as an Engineering Skill — What Design Docs, Postmortems, and Review Comments Actually Do
Everyone says writing matters for engineers, and the reason usually collapses into a story about promotion. This piece runs the order differently. Writing is first a device for verifying your own thinking, then a tool fo
2026-08-15 · 6 min read #career#skills#technical-writing#design-doc#postmortemWhy Diátaxis Gets Mistaken for Four Folders — And Why Two Modes in One Page Collapse
Diátaxis divides documentation into four kinds: tutorial, how-to, reference, and explanation. Yet most teams finish their adoption by creating four folders, and the actual problem stays exactly where it was. The real fai
2026-08-09 · 9 min read #documentation#diataxis#technical-writing#developer-experience#information-architectureThe Developer Who Works in Writing — Design Docs, ADRs, and Persuasive Technical Writing ♪ Listenable
Why writing is the senior engineer leverage skill, practical templates for design docs and ADRs, the craft of documents that survive review, bad-writing before/after fixes, and how to use AI for writing without losing yo
2026-06-12 · 22 min read #technical-writing#design-docs#adr#documentation#careerDeveloper English in the AI Era: AGENTS.md, System Prompts, RFCs — Writing the English Agents Read ♪ Listenable
In 2026, the highest-leverage English a developer writes is the English agents read. AGENTS.md / CLAUDE.md context files. System prompts for production agents. RFCs and design docs that humans and agents read together. I
2026-05-14 · 27 min read #developer-english#ai-writing#agents-md#claude-md#system-promptTechnical Writing Guide for Developers: RFC, ADR, Blog, API Docs, and Documentation Culture
Everything about developer writing! RFC (Request for Comments), ADR (Architecture Decision Records), API documentation (OpenAPI), README, CHANGELOG, tech blog writing, diagramming (Mermaid/PlantUML), and documentation cu
2026-03-24 · 18 min read #technical-writing#documentation#rfc#adr#api-docsTechnical Documentation Writing Guide for Developers: From README to ADR
Master technical documentation from README files and API docs to Architecture Decision Records. Learn the Diátaxis framework and modern documentation tools like Docusaurus, GitBook, and Mintlify.
2026-03-16 · 7 min read #documentation#technical-writing#soft-skills#developer#api-docsComplete Guide to English Report Writing: From Executive Summary to Data-Driven Reporting
A comprehensive guide to English report writing covering executive summary structure and data-driven reporting techniques.
2026-03-13 · 6 min read #english#report-writing#technical-writing#communication#business-writingTechnical Report Writing Guide: From Structure Design to Data Visualization and Automation
A comprehensive guide to technical report writing for IT engineers. Covers report structure design by type, the Pyramid Principle, MECE framework, data visualization techniques, markdown templates, and automation tools.
2026-03-13 · 16 min read #culture#report-writing#technical-writing#documentation#visualizationTechnical Writing in English Guide: RFC, ADR, Design Doc, and Tech Spec Templates with Practical Expressions
A practical guide to technical document writing for software engineers. Compare structures and templates for RFCs, ADRs, Design Docs, and Tech Specs. Learn key English expressions for each section (Problem Statement, Pro
2026-03-12 · 17 min read #english#technical-writing#rfc#adr#design-docThe Complete Guide to Technical Writing in English: RFC, ADR, and Design Doc Patterns
A comprehensive guide to writing technical documents used in global engineering teams. Covers the structure and writing patterns for RFCs, ADRs (Architecture Decision Records), and Design Docs, along with key English exp
2026-03-10 · 19 min read #english#technical-writing#rfc#adr#design-docComplete Guide to English Incident Communication: From Outage Reports to Postmortem Writing ♪ Listenable
An English incident communication guide for IT engineers. Covers initial incident reporting, escalation, status page updates, and postmortem writing with practical expressions and templates.
2026-03-08 · 26 min read #english#incident-communication#postmortem#sre#technical-writingPractical Guide to English Technical Writing: RFC, ADR, and Design Doc Templates ♪ Listenable
A guide to English technical document writing for engineers. Covers the structure and purpose of RFC, ADR, and Design Doc, effective English expressions, practical templates, review processes, and global team collaborati
2026-03-06 · 27 min read #english#technical-writing#rfc#adr#design-docTechnical Writing English Guide — How to Write Technical Documentation for Developers
Covers the essentials of Technical Writing, from writing READMEs, API docs, and RFCs to clear sentence structure and common English mistakes developers make.
2026-03-03 · 7 min read #english#technical-writing#documentation#2026-03