DEV Community

#documentation

Improving and writing documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
Notes to Self: The Interview Between an Issue and a Spec

Notes to Self: The Interview Between an Issue and a Spec

1
Comments
8 min read
Documentation Review for Mixed Teams: I Tested Theneo, ReadMe, GitBook, and Mintlify (2026)

Documentation Review for Mixed Teams: I Tested Theneo, ReadMe, GitBook, and Mintlify (2026)

3
Comments
14 min read
Turn Your API Docs Into an Executable Test Plan With a Free Model

Turn Your API Docs Into an Executable Test Plan With a Free Model

Comments
5 min read
Your README code examples are silently lying — I built a CLI to detect documentation drift using only AST, no LLM

Your README code examples are silently lying — I built a CLI to detect documentation drift using only AST, no LLM

2
Comments
3 min read
How to import Word documents into Confluence Cloud, and where the built-in import stops

How to import Word documents into Confluence Cloud, and where the built-in import stops

Comments
4 min read
Internal vs. External Documentation: What Belongs Where

Internal vs. External Documentation: What Belongs Where

Comments
5 min read
My README Promised Flags My CLI Doesn't Have. I Built a Drift Detector.

My README Promised Flags My CLI Doesn't Have. I Built a Drift Detector.

Comments
5 min read
Using LLMs as a Documentation Amplifier, Not a Shortcut

Using LLMs as a Documentation Amplifier, Not a Shortcut

Comments
2 min read
Types of Technical Documentation: 8 Essential Types, Plus Agent Instructions

Types of Technical Documentation: 8 Essential Types, Plus Agent Instructions

Comments
5 min read
How to Build and Maintain Skeleton Technical Docs using Claude (With Copy-Paste Prompts)

How to Build and Maintain Skeleton Technical Docs using Claude (With Copy-Paste Prompts)

Comments
2 min read
Markdown Tricks for Cleaner Docs

Markdown Tricks for Cleaner Docs

Comments
3 min read
The Hell Documentation

The Hell Documentation

Comments 2
3 min read
Please Define Your Jargon

Please Define Your Jargon

Comments
2 min read
Docs-as-Evals: The New Job Technical Writers Didn’t Expect

Docs-as-Evals: The New Job Technical Writers Didn’t Expect

Comments 4
6 min read
Neglect of Code Comments: Addressing Misconceptions and Promoting Best Practices for Effective Documentation

Neglect of Code Comments: Addressing Misconceptions and Promoting Best Practices for Effective Documentation

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