Anonymous View

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

Your Terraform estate documents itself now: meet iac-cartographer

1
Comments
5 min read
The Software Developer's Guide to AEO

The Software Developer's Guide to AEO

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

Docstrings vs Markdown Docs: What Should Developers Actually Write?

Comments
7 min read
Focused Work, Distraction-Free Coding

Focused Work, Distraction-Free Coding

Comments
3 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
The Power of "Documentation as a Contract"

The Power of "Documentation as a Contract"

Comments
6 min read
Documentation Structure Matters More Than You Think

Documentation Structure Matters More Than You Think

14
Comments 4
2 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
5 Markdown Tricks Every Developer Should Know (That Aren't in the Cheat Sheet)

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

Comments
2 min read
Capture the Reasoning Path, Not the Final State

Capture the Reasoning Path, Not the Final State

Comments 1
6 min read
How to Create Architecture Overviews from Existing Code

How to Create Architecture Overviews from Existing Code

Comments
7 min read
What Wrong Docs Cost Test Automation Teams

What Wrong Docs Cost Test Automation Teams

Comments
4 min read
Introducing Truthmark 1.4.0: Git-native truth workflows for AI coding agents

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

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