Browsing Tag
documentation
20 posts
Good and Bad Navigation Patterns for Long HTML Pages
Some HTML pages can run quite long. The longer the page, the more important clean, consistent navigation becomes.…
Automate Screenshots in Sphinx Documentation (With Dark Mode)
Sphinx has dark mode now. Furo, PyData, Read the Docs – most popular themes ship with a toggle.…
How I Built an MCP Server to Create My Own AI Writing Style Guide Expert
As a technical writer, my life revolves around corporate Writing Style Guides. The Writing Style Guide is my…
Stoplight Alternatives Developers Actually Work with
If you rely on Stoplight for API design, docs, and collaboration, you might be exploring tools that fit…
🧱 What Are Terraform Variables? (And Why They Save Your Sanity at Scale)
Hey everyone 👋 If you’re getting into Terraform, infrastructure as code (IaC), or building cloud environments that don’t…
How to Translate Document & Keep the Formatting
Need to translate a document and keep the formatting / layout in place for your company or organization?…
I Compared Four API Docs. Some Made Me Smile, Some Made Me Sigh
So, I’ve been neck-deep in API documentation lately—part of my whole technical writing journey. I figured, why not…
💻 What Is Infrastructure as Code? (And Why You Should Care If You’re Building on Azure)
Hey everyone 👋 If you’re getting into cloud, DevOps, or anything involving deploying software infrastructure, you’ve probably heard…
How to Write Technical Documentation in 2025: A Step-by-Step Guide
“I wrote this code three months ago, and now I can’t understand it at all…” “Where’s the project…
How to Document MySQL Databases Efficiently with DbSchema
Database documentation is essential for organizations using MySQL. Clear and comprehensive documentation enhances collaboration, streamlines development, and ensures…
