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
Stop Cloning Entire Repos for Your Doc Builds
saipramod profile

Stop Cloning Entire Repos for Your Doc Builds

#documentation #opensource #typescript #devops
Comments
5 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
Focused Work, Distraction-Free Coding
rudolfolah profile

Focused Work, Distraction-Free Coding

#productivity #writing #documentation
Comments
3 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
The Power of "Documentation as a Contract"
junihoj profile

The Power of "Documentation as a Contract"

#documentation #softwareengineering #backend #openapi
Comments
6 min read
Setting Up a Secure VPN Server on Ubuntu and Docker (Windows)
ngemuantony profile

Setting Up a Secure VPN Server on Ubuntu and Docker (Windows)

#vpn #wireguard #ubuntu #documentation
Comments 1
9 min read
When the Docs Lie
tacoda profile

When the Docs Lie

#documentation #productivity #softwareengineering #webdev
1
Comments
5 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
Why Your GitHub README Diagrams Look Amateur (and the 4 Fixes That Take 10 Minutes)
levi_liu profile

Why Your GitHub README Diagrams Look Amateur (and the 4 Fixes That Take 10 Minutes)

#mermaid #github #opinion #documentation
2
Comments
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
đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.