DEV Community

#documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
Clean Code Is Not the Same as Clear Code: Comments Were Never the Problem

Includes a helpful regex breakdown in the comments

Clean Code Is Not the Same as Clear Code: Comments Were Never the Problem

93
Picked as gem Comments 72
9 min read
Deploying BookStack - Open-Source Documentation Platform

Deploying BookStack - Open-Source Documentation Platform

Comments
6 min read
The Future of Product Documentation

The Future of Product Documentation

1
Comments
2 min read
Getting markdown from GitHub into Confluence: the four routes and what each one costs

Getting markdown from GitHub into Confluence: the four routes and what each one costs

Comments
5 min read
The Markdown File Changed Even Though I Only Edited One Word

The Markdown File Changed Even Though I Only Edited One Word

Comments
3 min read
What Crochet Patterns Can Teach Us About Writing Better Instructions

What Crochet Patterns Can Teach Us About Writing Better Instructions

Comments
3 min read
ADR: Recording the Why Behind Decisions and How ADR Guard Helps Keep Architectural History Reliable

ADR: Recording the Why Behind Decisions and How ADR Guard Helps Keep Architectural History Reliable

Comments
8 min read
Test the code examples in your MkDocs and Sphinx docs on every build

Test the code examples in your MkDocs and Sphinx docs on every build

Comments
3 min read
Launching My Tech Docs Hub: 2 Years, 100+ Articles on Systems Architecture, EDA, and Observability 🚀

Launching My Tech Docs Hub: 2 Years, 100+ Articles on Systems Architecture, EDA, and Observability 🚀

Comments
2 min read
Why Schema Diagrams Go Stale (and the Fix)

Why Schema Diagrams Go Stale (and the Fix)

Comments
3 min read
Stop Making AI Agents Grind Through Huge Codebases — I Built a Deterministic Wiki Build System for Them

Stop Making AI Agents Grind Through Huge Codebases — I Built a Deterministic Wiki Build System for Them

1
Comments
8 min read
The Most Damaging Bug I Found This Month Wasn't in Code — It Was Between Two Documents

The Most Damaging Bug I Found This Month Wasn't in Code — It Was Between Two Documents

Comments
4 min read
Turn Parser-Visible Flags Into a Config Reference Grid; Sign Defaults and Secret Classes

Turn Parser-Visible Flags Into a Config Reference Grid; Sign Defaults and Secret Classes

Comments
8 min read
Split Config Docs Into Extracted Keys and Operator-Signed Constraints

Split Config Docs Into Extracted Keys and Operator-Signed Constraints

Comments
8 min read
Amazon's advertising API docs return HTTP 200 for every URL, including ones that don't exist

Amazon's advertising API docs return HTTP 200 for every URL, including ones that don't exist

Comments
5 min read
👋 Sign in for the ability to sort posts by relevant, latest, or top.