DEV Community

#documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
Your Terraform estate documents itself now: meet iac-cartographer
anderson_leite profile

Your Terraform estate documents itself now: meet iac-cartographer

#terraform #devops #documentation #infrastructureascode
1
Comments
5 min read
Your README Is More Than Documentation
neithergalax profile

Your README Is More Than Documentation

#readme #documentation #github #beginners
2
Comments
5 min read
We moved all our docs into Git. Then nobody outside the team could read them.
mrbantsevich profile

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

#documentation #git #webdev #productivity
3
Comments
2 min read
Docstrings vs Markdown Docs: What Should Developers Actually Write?
anoop_kumar_paul profile

Docstrings vs Markdown Docs: What Should Developers Actually Write?

#ai #documentation #webdev #programming
Comments
7 min read
What it takes to build docs worth reading
lolocoding profile

What it takes to build docs worth reading

#documentation #developer #devrel #product
9
Comments
4 min read
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
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
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
How We Built Tamper-Evident Document Memory for AI Agents
sawftware profile
Aly

How We Built Tamper-Evident Document Memory for AI Agents

#rag #agents #mcp #documentation
Comments
3 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
👋 Sign in for the ability to sort posts by relevant, latest, or top.