DEV Community

#documentation

Improving and writing documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
PRD Template for Software Projects (Copy and Adapt)

PRD Template for Software Projects (Copy and Adapt)

1
Comments
5 min read
How to make a market-data figure checkable

How to make a market-data figure checkable

Comments
2 min read
How to Write a Help Article That Actually Resolves the Ticket

How to Write a Help Article That Actually Resolves the Ticket

Comments
8 min read
Architecture Starts With a Conversation, Not a Document

Architecture Starts With a Conversation, Not a Document

Comments
23 min read
Give Every Document Exactly One Place: Documentation Addressing (3)

Give Every Document Exactly One Place: Documentation Addressing (3)

Comments
21 min read
Make the Agent Read Only What It Should: Documentation Routing (2)

Make the Agent Read Only What It Should: Documentation Routing (2)

Comments
20 min read
Technical writing examples for definitions, warnings, config docs and code comments

Technical writing examples for definitions, warnings, config docs and code comments

1
Comments
4 min read
A Drift Budget for Model-Drafted Docs: Re-Verify Only the Sections That Changed

A Drift Budget for Model-Drafted Docs: Re-Verify Only the Sections That Changed

Comments
5 min read
API documentation examples and how to rewrite unclear endpoint docs

API documentation examples and how to rewrite unclear endpoint docs

Comments
4 min read
Measure the Executable Share of a Docs Page Before Letting a Model Draft It

Measure the Executable Share of a Docs Page Before Letting a Model Draft It

Comments
9 min read
The Fenced Block Principle

The Fenced Block Principle

1
Comments
6 min read
Tiered Doc Refresh: Pin Every Block to a Source Hash, and Let a Model Rewrite Only What It Owns

Tiered Doc Refresh: Pin Every Block to a Source Hash, and Let a Model Rewrite Only What It Owns

Comments
8 min read
What a Model May Draft in Docs: A Sentence-Role Contract and a Claim Quarantine Gate

What a Model May Draft in Docs: A Sentence-Role Contract and a Claim Quarantine Gate

Comments
7 min read
# How to Build a Knowledge Base That Support Agents Will Actually Use

# How to Build a Knowledge Base That Support Agents Will Actually Use

Comments
7 min read
Pin Each Drafted Doc Section to a Source Digest and Re-Draft Only What Moved

Pin Each Drafted Doc Section to a Source Digest and Re-Draft Only What Moved

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