DEV Community

#documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
Make the code examples in your Docusaurus docs runnable, in 46 languages

Make the code examples in your Docusaurus docs runnable, in 46 languages

Comments
4 min read
A claim-check checklist for small web-tool guides

A claim-check checklist for small web-tool guides

Comments
3 min read
Part 4: I wrote the page developers read when something breaks, and set up a Jira board to track it all.

Part 4: I wrote the page developers read when something breaks, and set up a Jira board to track it all.

4
Comments 2
1 min read
A small template for useful, privacy-aware support reports

A small template for useful, privacy-aware support reports

Comments
3 min read
Writing the contributor guide an open-source project didn't have, with Thally

Writing the contributor guide an open-source project didn't have, with Thally

Comments
10 min read
The Case for Keeping Document Conversion Stateless

The Case for Keeping Document Conversion Stateless

Comments
1 min read
Experiment: what share of the links in your GitHub READMEs still work? Measure every repo you own in 15 minutes

Experiment: what share of the links in your GitHub READMEs still work? Measure every repo you own in 15 minutes

Comments
5 min read
How a Lapidarc document proves itself

How a Lapidarc document proves itself

Comments
1 min read
Your Docs Are Too Long. A Word-Count Checklist for Developer Writing

Your Docs Are Too Long. A Word-Count Checklist for Developer Writing

Comments
3 min read
The Card Title Is the Target Guide's Own Heading: 39 of 39, Word for Word

The Card Title Is the Target Guide's Own Heading: 39 of 39, Word for Word

Comments
4 min read
Agents Picked the Better-Described Tool 72% of the Time. Here's How to Write One.

Agents Picked the Better-Described Tool 72% of the Time. Here's How to Write One.

Comments
6 min read
Lock the Gates: How to Give VIP Access to Your Docs

Lock the Gates: How to Give VIP Access to Your Docs

Comments
2 min read
Why PDF-to-Word Converters Trap Multi-Column Papers & Legal Briefs in Floating Text Boxes

Why PDF-to-Word Converters Trap Multi-Column Papers & Legal Briefs in Floating Text Boxes

Comments
4 min read
How to Choose a Document Parsing API: What to Test Before You Commit

How to Choose a Document Parsing API: What to Test Before You Commit

Comments
12 min read
The Description Layer of Our Own llms.txt: 47 of 55 Repeat the Page's Meta Description, and 39 Bullets Carry No Link

The Description Layer of Our Own llms.txt: 47 of 55 Repeat the Page's Meta Description, and 39 Bullets Carry No Link

Comments
4 min read
👋 Sign in for the ability to sort posts by relevant, latest, or top.