DEV Community

#documentation

Improving and writing documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
Draft the Migration Note. Refuse the Unsigned Number.

Draft the Migration Note. Refuse the Unsigned Number.

Comments
7 min read
From Markdown to Explainer Video: A Developer's Workflow for Documentation People Actually Watch

From Markdown to Explainer Video: A Developer's Workflow for Documentation People Actually Watch

1
Comments
4 min read
Terminology drift is the quiet tax on a large content corpus

Terminology drift is the quiet tax on a large content corpus

Comments
3 min read
Modeling Waterfront Assets with Shapezo: A Typed Content Pipeline for Docks, Piers, and Wharves

Modeling Waterfront Assets with Shapezo: A Typed Content Pipeline for Docks, Piers, and Wharves

Comments
2 min read
Keep Escalation Facts Out of Model-Drafted Troubleshooting Pages

Keep Escalation Facts Out of Model-Drafted Troubleshooting Pages

Comments
9 min read
Why Most User Documentation Fails (And How to Fix Yours)

Why Most User Documentation Fails (And How to Fix Yours)

1
Comments
4 min read
Record What You Rejected, and Make Your Agent Check It: Lessons from 495 ADRs

Record What You Rejected, and Make Your Agent Check It: Lessons from 495 ADRs

5
Comments 15
7 min read
How to Generate API Documentation from an OpenAPI Spec (2026 Guide)

How to Generate API Documentation from an OpenAPI Spec (2026 Guide)

Comments
5 min read
Pin Failure Contracts Before Drafting Troubleshooting Pages

Pin Failure Contracts Before Drafting Troubleshooting Pages

Comments
8 min read
The Model May Draft the Example. It May Not Bind the Client.

The Model May Draft the Example. It May Not Bind the Client.

Comments
7 min read
Part 3: I turned my API design into an OpenAPI spec.

Part 3: I turned my API design into an OpenAPI spec.

5
Comments 4
1 min read
Fail the Docs Build When CLI Examples Drift From a Fixture Ledger

Fail the Docs Build When CLI Examples Drift From a Fixture Ledger

Comments
9 min read
A Claim-Class Router That Keeps Generated Docs From Owning Support Facts

A Claim-Class Router That Keeps Generated Docs From Owning Support Facts

Comments
8 min read
Gate Changelog Drafts With a Signed Release Impact Packet

Gate Changelog Drafts With a Signed Release Impact Packet

Comments
9 min read
Gate Generated Config Guides with an Extract and an Owner File

Gate Generated Config Guides with an Extract and an Owner File

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