DEV Community

#documentation

Improving and writing documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
Contract intelligence & AI-powered document automation system

Contract intelligence & AI-powered document automation system

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

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

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

Capture the Reasoning Path, Not the Final State

Comments 1
6 min read
Over-Documentation Is Not Waste for AI Systems

Over-Documentation Is Not Waste for AI Systems

1
Comments
6 min read
How I Documented an Entire Product in 4 Days with an AI Agent

Uses Block's open-source Goose agent

How I Documented an Entire Product in 4 Days with an AI Agent

72
Comments 18
19 min read
Business Flow as a Part of Technical Documentation: Why Tech Leads Should Own It

Business Flow as a Part of Technical Documentation: Why Tech Leads Should Own It

Comments
3 min read
I Audited 30 Developer Documentation Sites. Here's What the Best Ones Do Differently.

I Audited 30 Developer Documentation Sites. Here's What the Best Ones Do Differently.

Comments
2 min read
Why File Paths Are Not Enough for AI Knowledge

Why File Paths Are Not Enough for AI Knowledge

Comments
5 min read
How to Create Architecture Overviews from Existing Code

How to Create Architecture Overviews from Existing Code

1
Comments
7 min read
Express is the only major framework where FastAPI-style automated API docs still don't exist

Express is the only major framework where FastAPI-style automated API docs still don't exist

2
Comments
1 min read
I Built an AI CLI Tool That Generates Beautiful READMEs Automatically

I Built an AI CLI Tool That Generates Beautiful READMEs Automatically

Comments
4 min read
ReadMe for Github

ReadMe for Github

Comments 1
2 min read
How Developers Can Optimize Documentation for AI Search (ChatGPT, Gemini, Perplexity)

How Developers Can Optimize Documentation for AI Search (ChatGPT, Gemini, Perplexity)

3
Comments
2 min read
Building ARCHITECTURE.md Files That Prevent AI From Making Silent Architectural Decisions

Building ARCHITECTURE.md Files That Prevent AI From Making Silent Architectural Decisions

Comments 2
3 min read
Running FreeIPA on Ubuntu Using Podman – Part 1: Overview

Running FreeIPA on Ubuntu Using Podman – Part 1: Overview

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