DEV Community

#documentation

Improving and writing documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
Could a New Teammate Follow Your Runbook Page Alone?

Could a New Teammate Follow Your Runbook Page Alone?

Comments
4 min read
Install a lightweight ADR process in 30 minutes

Install a lightweight ADR process in 30 minutes

Comments 1
5 min read
How to Document Your Database Schema for a Team

How to Document Your Database Schema for a Team

Comments 1
3 min read
Diagrams as Code: Keep Your Architecture Docs Alive Inside the Repo

Diagrams as Code: Keep Your Architecture Docs Alive Inside the Repo

Comments 1
7 min read
VPN Client, Profile, and Service: Debug the Right Layer

VPN Client, Profile, and Service: Debug the Right Layer

Comments
4 min read
Your AI-written README is probably lying: an evidence-first docs loop (with 2 free prompts)

Your AI-written README is probably lying: an evidence-first docs loop (with 2 free prompts)

2
Comments 2
7 min read
I tested my own docs like a stranger. They failed 24 times.

I tested my own docs like a stranger. They failed 24 times.

1
Comments 6
3 min read
The Need for a Modern UML and Diagram Engine (Part 2)

The Need for a Modern UML and Diagram Engine (Part 2)

1
Comments 1
3 min read
Catch Broken Markdown Links and #Anchors Offline Before They Hit Production with DeadLinkFinder

Catch Broken Markdown Links and #Anchors Offline Before They Hit Production with DeadLinkFinder

1
Comments
3 min read
Por que decisões de engenharia se perdem

Por que decisões de engenharia se perdem

1
Comments 1
3 min read
The Confluence content manager: what it does and where it stops

The Confluence content manager: what it does and where it stops

Comments
6 min read
Docs Don't Rot, Claims Do: An Expiry Ledger for Model-Drafted Pages

Docs Don't Rot, Claims Do: An Expiry Ledger for Model-Drafted Pages

1
Comments 1
6 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
We replaced StackBlitz and CodeSandbox with a self-hosted demo runner. Here's everything that broke along the way.

We replaced StackBlitz and CodeSandbox with a self-hosted demo runner. Here's everything that broke along the way.

1
Comments
1 min read
How to build beautiful, modern API documentation from OpenAPI in 2026

How to build beautiful, modern API documentation from OpenAPI in 2026

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