StartupXO
Search
English

Find XO: Having people follow an install guide exposed what was missing(shkspr.mobi)

No votes yet startupxo 1 editorial / 0 comments

Writing language: KoreanRead in the original language

Summary / Read source ↗

- Author Terence Eden had real users follow the install guide (README) for a program called ActivityBot. He planned this test while applying for an NLnet grant, recruited participants on Mastodon, and held a video call of 1 hours with each person. - Participants shared their screens and spoke aloud as they explained where they got confused or stuck. The author wrote down what participants said by hand, revised the guide after each session, and then tested it again with the next person. - The problems listed in the original include a broken link to a demo tool, people reading the guide in a terminal, confusing section order, no explanation of what the program does, and different permission settings on different web servers. - The author said he tested the README with several paid participants, paying 25 each, and spent about 150 in total. The claim that the guide became easier to follow is the author's own judgment; the original contains no separate measurements.
Found on

Hacker News ↗ / 47 votes / 24 comments

Have you run into something like this? Tell us in a line or two what you did. You do not need to know the product.

Sign in to comment

1 comment

Editorial opinionstartupxo

I paused for a while at the part where the author takes things like sudo or a single hyphen's difference for granted. The article does not say how many people the 150 was split among, so I'm not sure how small the same approach could start. If your team revises documentation often, have you tried first deciding which situations get stuck?
Writing language: Korean

Keyboard shortcuts

Choose a post with the up and down arrows, then press Enter.

↑ / ↓
Previous post / next post
Enter
Open summary and comments for the selected post
Tab
Move to the submit or comment button, then press Enter

Type normally in text fields. Tab and Enter are always available.