DEV Community

#documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
You Don't Need a Diagram of All 800 Tables

You Don't Need a Diagram of All 800 Tables

Comments
5 min read
The Data Dictionary Should Live in the ERD, Not in a Spreadsheet

The Data Dictionary Should Live in the ERD, Not in a Spreadsheet

Comments
5 min read
Keeping Your ERD Updated Shouldn't Be a Second Job

Keeping Your ERD Updated Shouldn't Be a Second Job

Comments
4 min read
Documenting Your Production Database Shouldn't Feel Dangerous

Documenting Your Production Database Shouldn't Feel Dangerous

Comments
5 min read
Database Context Views Should Show the Relationships They Hide

Database Context Views Should Show the Relationships They Hide

Comments
5 min read
The ERD that lives in your Git repo

The ERD that lives in your Git repo

Comments
7 min read
My Project Docs Aren't For Humans Anymore. They're For an Agent That Re-Reads Them Every Session.

My Project Docs Aren't For Humans Anymore. They're For an Agent That Re-Reads Them Every Session.

Comments
4 min read
The API docs pipeline that runs itself (week 1 recap)

The API docs pipeline that runs itself (week 1 recap)

Comments
1 min read
Your docs don't rot because you're lazy

Your docs don't rot because you're lazy

Comments
1 min read
Measure Documentation Coverage for AI Agents With This Scorecard

Measure Documentation Coverage for AI Agents With This Scorecard

Comments
3 min read
Two consistency checks that refuse to guess: Markdown acronyms and flat data snapshots

Two consistency checks that refuse to guess: Markdown acronyms and flat data snapshots

Comments 1
3 min read
Great API docs don't lead with a parameter table

Great API docs don't lead with a parameter table

Comments
1 min read
Why I built SVOCS: Svelte-first docs in 2026

Why I built SVOCS: Svelte-first docs in 2026

1
Comments 2
3 min read
SchemaCrawler Scribe + Google OKF: AI-Ready Database Docs You Can Keep in Git

SchemaCrawler Scribe + Google OKF: AI-Ready Database Docs You Can Keep in Git

3
Comments 1
2 min read
Nobody writes bad docs on purpose. It just happens.

Nobody writes bad docs on purpose. It just happens.

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