Tag: #documentation
Writing on GPUs, LLMs, MLOps, Kubernetes — and mindset · 15 posts
15 posts are tagged #documentation; the most recent was published on 2026-08-14.
Often tagged together: #technical-writing 6 #2026-03 5 #communication 4 #adr 3 #culture 3
Most read in the last 90 days:
- Static Site Generators 2026 Head-to-Head — Hugo · Eleventy · Astro · MkDocs · Docusaurus · Mintlify · Starlight · Nextra · VitePress · Jekyll · Zola Deep Dive
- IT Project Deliverables Complete Guide: All Documents from Planning to Closure
- The Developer Who Works in Writing — Design Docs, ADRs, and Persuasive Technical Writing
The Claim That Understanding Is the Bottleneck, and Its Circularity — When the Explainer Is the Thing Under Review
An essay on what remains when agents produce code faster than people can read it drew a long discussion. The author proposes moving the goal from understanding-to-verify to understanding-to-participate, and offers three
2026-08-14 · 7 min read #engineering-culture#code-review#developer-experience#documentation#ai-assisted-developmentWhy 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-architectureWhen Does a Code Screenshot in Your Docs Start Lying — Turning Images into Build Artifacts
A code screenshot captured by hand and pasted into a document is an artifact with no source. The code changes and the image does not, so at some point it quietly starts showing something false. Generate the image from a
2026-08-09 · 8 min read #documentation#developer-tools#cli#ci#automationWriting Great Client-Facing Documentation — Communication That Builds Trust
From proposals to incident reports, the documents you send to clients are vessels of trust. This guide covers writing patterns for each document type, audience awareness, clarity, tone, and the legal implications of lang
2026-07-01 · 17 min read #documentation#communication#writing#client#soft-skillsHow to Communicate Through Documents — Writing That Gets Read Again ♪ Listenable
Documents are the center of collaboration and handoff, and because they are read again and again, they deserve care. This covers document structure that puts purpose and conclusion first, consideration for the reader, as
2026-06-19 · 20 min read #documentation#writing#communication#async#collaborationWord Productivity — Styles, Shortcuts, and Long-Document Automation
A practical guide to automating long reports in Microsoft Word using styles, shortcuts, tables of contents, captions and cross-references, headers and footers, advanced find and replace, the review tools, and mail merge.
2026-06-15 · 15 min read #word#productivity#office#styles#shortcutsThe 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#careerStatic Site Generators 2026 Head-to-Head — Hugo · Eleventy · Astro · MkDocs · Docusaurus · Mintlify · Starlight · Nextra · VitePress · Jekyll · Zola Deep Dive ♪ Listenable
The SSGs that survived past the Next.js and Vite era — Hugo, Eleventy 3, Astro, MkDocs Material, Docusaurus, Mintlify, Starlight, Nextra, VitePress, Jekyll, Zola — compared along two axes: content sites and documentation
2026-05-14 · 22 min read #static-site#ssg#hugo#eleventy#mkdocsThe Complete Developer Writing Guide: Design Doc, RFC, Blog, Book, Conference Talk (2025)
80% of a Staff+ engineer's influence comes from writing, not code. Breaking down Google's Design Doc template, the RFC processes of Rust/Python/Node, the blogs of Julia Evans/Dan Luu/Stratechery, the O'Reilly/Manning pub
2026-04-15 · 17 min read #writing#design-doc#rfc#tech-blog#conference-talkTechnical 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-docsIT Project Deliverables Complete Guide: All Documents from Planning to Closure ♪ Listenable
Complete guide to all deliverables produced in Korean IT projects — from RFP and proposal through analysis, design, implementation, testing, migration, and project closure. Includes public sector specific documents.
2026-03-17 · 23 min read #project-management#deliverables#pm#pmp#software-developmentTechnical 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-docsTechnical 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#visualizationJapanese Technical Documentation Writing for IT Engineers: Specifications, Design Docs, and Incident Reports
Learn how to write essential technical documents (specifications, design documents, incident reports) used in Japanese IT workplaces. Covers document structure, must-know expressions, and honorific usage with practical e
2026-03-03 · 13 min read #japanese#tech-writing#specification#documentation#business-japaneseTechnical 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