A definitive, comprehensive blueprint for crafting a standout technical writing portfolio: anatomy of an irresistible case study, handling NDAs, building live code samples, and self-hosting.
A masterclass on the Diátaxis documentation framework: separating Tutorials, How-To Guides, Reference, and Explanation to eliminate user cognitive overload and information architecture chaos.
A comprehensive guide to implementing the Docs-as-Code methodology: Git branching strategies, Markdown formatting, automated link checking, Vale prose linting, and continuous deployment.
How technical writers use Generative AI responsibly: writing structured Model Cards for ML systems, drafting API docs with prompt engineering templates, and architecting RAG vector...
How to document modern cloud infrastructure: automated Terraform module documentation with terraform-docs, Custom Resource Definitions (CRDs), and C4 model architecture diagrams.
A technical writer’s operational playbook for Site Reliability Engineering: structuring actionable 3 AM runbooks, alert routing, blast radius calculation, and blameless post-mortem RCA templates.
A comprehensive, rule-by-rule analysis comparing the two most influential editorial standards in tech: tone, heading capitalization, second person, code formatting, and automated Vale enforcement.
An architectural evaluation of the top four documentation static site generators: benchmark build times, Pagefind vs Algolia search, MDX component support, versioning, and decision matrix.
How to automate editorial review using Vale: configuring .vale.ini, loading Google and Microsoft style packages, writing custom regex and AST rules, and integrating PR review...
How to craft copy-pasteable, verified SDK code samples that reduce Time-to-First-Hello-World (TTFHW). Covers multi-language tabs, mock credentials, and automated code test harnesses.
How to design, document, and standardize REST API error responses using RFC 9457 and RFC 7807 Problem Details. Includes concrete JSON payloads, error catalogues, and...
How to document high-performance gRPC services and Protocol Buffers (proto3): documenting streaming RPCs, generating automated reference docs with protoc-gen-doc, and managing schema evolution.
A comprehensive guide to documenting GraphQL APIs: writing expressive Schema Definition Language (SDL) comments, managing deprecation lifecycles, and documenting query depth limits.
A production masterclass on OpenAPI Specification 3.1: JSON Schema Draft 2020-12 alignment, polymorphic schemas, webhooks, authentication contracts, and interactive documentation tooling.
Elevate Your Technical Writing & DX
Get practical, high-value tutorials on API documentation, CI/CD pipelines, and Docs-as-Code delivered directly to your inbox. No spam.