DEV Community

#documentation

Improving and writing documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
Stop letting examples lie: make your OpenAPI spec the single source of truth for docs, mocks, and agents

Stop letting examples lie: make your OpenAPI spec the single source of truth for docs, mocks, and agents

Comments
4 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
How llms.txt files follow the format: 438 files counted

How llms.txt files follow the format: 438 files counted

Comments
5 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
I replayed 7 repos' READMEs in fresh clones. 2 of them fail their own quickstart.

I replayed 7 repos' READMEs in fresh clones. 2 of them fail their own quickstart.

Comments 1
2 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
# How to Build a Self-Service Troubleshooting Library

# How to Build a Self-Service Troubleshooting Library

Comments
4 min read
How to Embed Docs and an AI Assistant Inside Your Product with Documentation.AI

How to Embed Docs and an AI Assistant Inside Your Product with Documentation.AI

23
Comments 1
7 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
đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.