DEV Community

#documentation

Improving and writing documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
An Entity Factsheet for AI Search: A Practical Site-Wide QA Checklist

An Entity Factsheet for AI Search: A Practical Site-Wide QA Checklist

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
The Hell Documentation

The Hell Documentation

Comments 2
3 min read
Documenting GTA 6 characters and regions without leaks

Documenting GTA 6 characters and regions without leaks

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

Technical Documentation Best Practices, Tested on Real Developer Docs

Comments
4 min read
Why AI Coding Agents Still Get APIs Wrong Even When They Have Documentation

Why AI Coding Agents Still Get APIs Wrong Even When They Have Documentation

1
Comments 3
1 min read
The MCP URL answered. The docs generator still wanted a snapshot.

The MCP URL answered. The docs generator still wanted a snapshot.

2
Comments
5 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
AI Agents Don't Read Your API Docs Like Developers Do

AI Agents Don't Read Your API Docs Like Developers Do

1
Comments 5
9 min read
Building a Structured FR Legends Changelog

Building a Structured FR Legends Changelog

2
Comments
1 min read
How to Use the OpenWeatherMap API — A Practical Guide.

How to Use the OpenWeatherMap API — A Practical Guide.

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