DEV Community

#documentation

Improving and writing documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
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
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
Types of Technical Documentation: 8 Essential Types, Plus Agent Instructions

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

Comments
5 min read
Markdown Tricks for Cleaner Docs

Markdown Tricks for Cleaner Docs

Comments
3 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
Technical Documentation Best Practices, Tested on Real Developer Docs

Technical Documentation Best Practices, Tested on Real Developer Docs

Comments
4 min read
How to Build a Useful Game Changelog for a Growing Gaming Community

How to Build a Useful Game Changelog for a Growing Gaming Community

2
Comments
4 min read
Building a Structured FR Legends Changelog

Building a Structured FR Legends Changelog

2
Comments
1 min read
Writing Docs for AI

Writing Docs for AI

1
Comments
5 min read
Markdown Tricks for Cleaner Docs

Markdown Tricks for Cleaner Docs

Comments
3 min read
How I Turned a Technical Writing Team Upside Down...Or, Downside Up?

How I Turned a Technical Writing Team Upside Down...Or, Downside Up?

1
Comments
3 min read
How I used AI to rename 4 products across 695 files in 3 days

How I used AI to rename 4 products across 695 files in 3 days

Comments
11 min read
SSMS Database Diagrams: Your ERD Is Trapped Inside the Database It Documents

SSMS Database Diagrams: Your ERD Is Trapped Inside the Database It Documents

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