DEV Community

#documentation

Improving and writing documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
GitHub for writers: Navigating pull request reviews

GitHub for writers: Navigating pull request reviews

1
Comments 2
6 min read
Reverse Engineer Any Database into dbdiagram.io, PlantUML, Mermaid, or QuickDBD - Then Keep Designing

Reverse Engineer Any Database into dbdiagram.io, PlantUML, Mermaid, or QuickDBD - Then Keep Designing

Comments
6 min read
Podlite 2.0 released

Podlite 2.0 released

Comments
3 min read
Most AI developer tools didn't add AI. They added a chat window.

Most AI developer tools didn't add AI. They added a chat window.

31
Comments 1
3 min read
PrestaShop Development: Is Documentation Really the Problem?

PrestaShop Development: Is Documentation Really the Problem?

Comments
4 min read
Your Terraform estate documents itself now: meet iac-cartographer

Your Terraform estate documents itself now: meet iac-cartographer

1
Comments
5 min read
Your README Is More Than Documentation

Your README Is More Than Documentation

2
Comments
5 min read
We moved all our docs into Git. Then nobody outside the team could read them.

We moved all our docs into Git. Then nobody outside the team could read them.

3
Comments
2 min read
Docstrings vs Markdown Docs: What Should Developers Actually Write?

Docstrings vs Markdown Docs: What Should Developers Actually Write?

Comments
7 min read
What it takes to build docs worth reading

What it takes to build docs worth reading

11
Comments
4 min read
Checkbox theater: how I stopped trusting my AI agent to run the checks

Checkbox theater: how I stopped trusting my AI agent to run the checks

Comments
8 min read
Everyone Needs a README for Their Life

Everyone Needs a README for Their Life

Comments
5 min read
Turning text into diagrams with AI: field notes from documenting a side project

Turning text into diagrams with AI: field notes from documenting a side project

Comments
3 min read
Technical Writing Advice

Documentation as a system interface

Technical Writing Advice

21
Comments 9
6 min read
How to Write a Killer PCB Design Document (and Why Your Firmware Team Will Thank You)

How to Write a Killer PCB Design Document (and Why Your Firmware Team Will Thank You)

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