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

45
Picked as gem Comments 31
9 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
AGENTS.md is now the most-read document in your company. It is also the worst-written.

AGENTS.md is now the most-read document in your company. It is also the worst-written.

Comments
7 min read
Sentinel Dev Diary: Where the Check Lives

Sentinel Dev Diary: Where the Check Lives

Comments
9 min read
# How to Build a Self-Service Troubleshooting Library

# How to Build a Self-Service Troubleshooting Library

Comments
4 min read
Drop-in Django app to serve a decent LLM-ready documentation site

Drop-in Django app to serve a decent LLM-ready documentation site

Comments
2 min read
Managed-Device VPN Preflight: Check Policy Before Debugging Setup

Managed-Device VPN Preflight: Check Policy Before Debugging Setup

Comments
3 min read
How i documented a Broken codebase without losing my mind.

How i documented a Broken codebase without losing my mind.

Comments
5 min read
A Useful VPN Bug Report Starts with the Last Successful Step

A Useful VPN Bug Report Starts with the Last Successful Step

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