DEV Community

#documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
How to Write a README That Explains Your Project in 30 Seconds

How to Write a README That Explains Your Project in 30 Seconds

Comments 1
5 min read
Moving docs from a GitHub wiki to a docs site? An 11-point checklist so the links survive

Moving docs from a GitHub wiki to a docs site? An 11-point checklist so the links survive

Comments
5 min read
Our code cites a 218-line specification 101 times, and the file was deleted two days after it was written

Our code cites a 218-line specification 101 times, and the file was deleted two days after it was written

Comments
7 min read
Runnable code examples in MkDocs and Material for MkDocs, in 46 languages

Runnable code examples in MkDocs and Material for MkDocs, in 46 languages

Comments
4 min read
How to Document a REST API with DocStar: Let Your AI Agent Draft It

How to Document a REST API with DocStar: Let Your AI Agent Draft It

Comments
7 min read
We deleted 551 words of "we could not find a source" from 42 pages, and a grep found the same habit on 20 more

We deleted 551 words of "we could not find a source" from 42 pages, and a grep found the same habit on 20 more

Comments
6 min read
Semantic Retrieval Evaluation Sets for Internal Engineering Docs in Node.js (5 Tests)

Semantic Retrieval Evaluation Sets for Internal Engineering Docs in Node.js (5 Tests)

Comments
5 min read
How to Write MCP Tool Descriptions That AI Agents Actually Understand

How to Write MCP Tool Descriptions That AI Agents Actually Understand

Comments
4 min read
Requirements Traceability Matrix (RTM): Template and Example

Requirements Traceability Matrix (RTM): Template and Example

1
Comments
5 min read
ArchiMate® diagrams as code with Mermaid

ArchiMate® diagrams as code with Mermaid

2
Comments 1
8 min read
I checked 263 Microsoft Learn pages for their AI note. The label's spelling decides whether readers see it

I checked 263 Microsoft Learn pages for their AI note. The label's spelling decides whether readers see it

Comments 2
6 min read
How to Add a Pre-Commit Quality Gate to Your Docs

How to Add a Pre-Commit Quality Gate to Your Docs

Comments 1
4 min read
Business Requirements Document (BRD) Template and Example

Business Requirements Document (BRD) Template and Example

1
Comments
5 min read
Find the Salesforce fields, flows and validation rules only your senior can explain

Find the Salesforce fields, flows and validation rules only your senior can explain

Comments 1
3 min read
Property Operations Search: Freshness Windows for Cited Engineering Documentation

Property Operations Search: Freshness Windows for Cited Engineering Documentation

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