DEV Community

# documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
Checkbox theater: how I stopped trusting my AI agent to run the checks
wordcaster profile

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

#ai #technicalwriting #documentation #devrel
Comments
8 min read
Everyone Needs a README for Their Life
m3yevn profile

Everyone Needs a README for Their Life

#documentation #devdiscuss #development
Comments
5 min read
Turning text into diagrams with AI: field notes from documenting a side project
aukedh profile

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

#ai #productivity #tools #documentation
Comments
3 min read
The Power of "Documentation as a Contract"
junihoj profile

The Power of "Documentation as a Contract"

#documentation #softwareengineering #backend #openapi
Comments
6 min read
Technical Writing Advice

Documentation as a system interface
pauljlucas profile

Technical Writing Advice

#documentation #technical #writing
21
Comments 9
6 min read
How to Write a Killer PCB Design Document (and Why Your Firmware Team Will Thank You)
maggie-pcb profile

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

#pcbdesign #hardwareengineering #firmware #documentation
Comments
6 min read
My README said 80 tools. My code had 96. Nobody noticed for weeks.
achiya-automation profile

My README said 80 tools. My code had 96. Nobody noticed for weeks.

#opensource #documentation #devtools #ai
2
Comments 6
4 min read
5 Markdown Tricks Every Developer Should Know (That Aren't in the Cheat Sheet)
zhihu_wu_dea1d82af01a04d7 profile

5 Markdown Tricks Every Developer Should Know (That Aren't in the Cheat Sheet)

#markdown #github #documentation #webdev
Comments
2 min read
Capture the Reasoning Path, Not the Final State
niclydon profile

Capture the Reasoning Path, Not the Final State

#ai #documentation #devops #productivity
Comments 1
6 min read
How to Create Architecture Overviews from Existing Code
anoop_kumar_paul profile

How to Create Architecture Overviews from Existing Code

#code #documentation #ai #webdev
Comments
7 min read
What Wrong Docs Cost Test Automation Teams
ekline profile

What Wrong Docs Cost Test Automation Teams

#ai #documentation #qa
Comments
4 min read
Introducing Truthmark 1.4.0: Git-native truth workflows for AI coding agents
merlin_h_2636e3753c2e642e profile

Introducing Truthmark 1.4.0: Git-native truth workflows for AI coding agents

#ai #documentation #programming #opensource
Comments
5 min read
I kept saying the same five things in every doc review. So I made them defaults.
wordcaster profile

I kept saying the same five things in every doc review. So I made them defaults.

#ai #technicalwriting #documentation #devrel
Comments
8 min read
The Types of Podcast Awards, Explained
recognizedfm profile

The Types of Podcast Awards, Explained

#documentation #productivity #awards
1
Comments
10 min read
Exactly convert docs to plain text (including list styles)
stining_pilot profile

Exactly convert docs to plain text (including list styles)

#webdev #javascript #documentation #softwaredevelopment
2
Comments
1 min read
👋 Sign in for the ability to sort posts by relevant, latest, or top.