DEV Community

# documentation

Improving and writing documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
The README Trap: Why AI Coding Assistants Skip Your Docs (and 3 Fixes)

The README Trap: Why AI Coding Assistants Skip Your Docs (and 3 Fixes)

1
Comments
4 min read
Key Issues in Legacy AMS Applications - And How to Support Them Effectively

Key Issues in Legacy AMS Applications - And How to Support Them Effectively

1
Comments
3 min read
The UX of README Files

The UX of README Files

1
Comments 1
5 min read
Database documentation fails when it relies on human discipline

Database documentation fails when it relies on human discipline

Comments
1 min read
Database documentation fails when it relies on human discipline

Database documentation fails when it relies on human discipline

Comments
1 min read
dbt docs: generate, write, and host them

dbt docs: generate, write, and host them

1
Comments
7 min read
Stop Writing README Files by Hand: Auto-Generate API Docs on Every Merge

Stop Writing README Files by Hand: Auto-Generate API Docs on Every Merge

Comments
3 min read
Generate Beautiful READMEs from Your Code Automatically

Generate Beautiful READMEs from Your Code Automatically

1
Comments
3 min read
What AI actually changed about my work as a technical writer

What AI actually changed about my work as a technical writer

1
Comments
4 min read
Scalar Has a Free API — Beautiful API Documentation in Seconds

Scalar Has a Free API — Beautiful API Documentation in Seconds

1
Comments
2 min read
MD Files Connector — Stop Losing Track of Your Markdown Docs

MD Files Connector — Stop Losing Track of Your Markdown Docs

1
Comments
1 min read
A Practical Checklist for Writing User Stories Developers Can Build

A Practical Checklist for Writing User Stories Developers Can Build

1
Comments
4 min read
RTM Execution Checklist: From Ticket Links to Test Proof

RTM Execution Checklist: From Ticket Links to Test Proof

1
Comments
4 min read
Before You Rely on AI for Coding, Fix Your Docs First

Before You Rely on AI for Coding, Fix Your Docs First

Comments 1
3 min read
How I built a practical agent skill that turns rough READMEs into polished project docs

How I built a practical agent skill that turns rough READMEs into polished project docs

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