Mmastodon first seen 18 h ago, last 13 min ago, peak #4
Developer argues for actually testing your README files
Original: How to *actually* test your readme
Blogger Terence Eden has published a piece arguing that software READMEs are rarely tested and often leave users stuck. He walks through the typical Linux install experience: following instructions that assume knowledge of unarchiving .tar.xz files, running a setup.sh script that fails, and hunting for missing steps. He proposes that writers verify documentation by following it fresh, the way a new user would.
Why now: The post resonates with developers who routinely hit broken or incomplete installation instructions, prompting discussion about documentation quality.
Rank over time, top of the chart is #1. 2 snapshots from 28 min ago to 13 min ago.
Evidence
- How to *actually* test your readme · Terence Eden’s Blog
If you've spent any time using Linux, you'll be used to installing software like this: The README says to download from this link. Huh, I'm not sure how to unarchive .tar.xz files - guess I'll search for that. Right, it says run setup.sh hmm, that doesn't work. Oh, I need to…
API: https://socialmediatrends-api.osmike.com/v1/trends/1363628