DEV Community

#documentation

Improving and writing documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
Your Docs are Outdated. You Just Don't Know Which Ones.

Your Docs are Outdated. You Just Don't Know Which Ones.

3
Comments
6 min read
Technical Documentation Template: Build Product Docs With a Tested Structure

Technical Documentation Template: Build Product Docs With a Tested Structure

5
Comments
5 min read
Your Migration Guide Is Already Wrong

Your Migration Guide Is Already Wrong

Comments
9 min read
Nobody fetched my llms.txt

Nobody fetched my llms.txt

5
Comments 2
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
House rules

House rules

Comments
9 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
A Second Brain Your AI Agent Can Read: Obsidian + Claude

Clean markdown storage enables smart agent context

A Second Brain Your AI Agent Can Read: Obsidian + Claude

15
Comments 28
5 min read
Deprecation Doesn't Reach the Copies

Deprecation Doesn't Reach the Copies

Comments
6 min read
Treat Runbook Status as Cached Data

Treat Runbook Status as Cached Data

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

Nobody writes bad docs on purpose. It just happens.

Comments
1 min read
ktx Docs Review: Excellent for AI Agents, One Onboarding Gap

ktx Docs Review: Excellent for AI Agents, One Onboarding Gap

Comments
4 min read
đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.