Hacker News Digest

11 октября 2026 г. в 11:47 • shkspr.mobi • ⭐ 314 • 💬 166

Original • HN

#documentation#readme#user-testing

I paid people to try and follow my README

Автор признаёт, что документация часто страдает от предвзятости разработчиков, которые считают очевидным то, что для пользователей непонятно. Чтобы исправить это, он заплатил добровольцам €25 за час, чтобы те следовали его README вслух, делясь мыслями и трудностями. Такой подход выявил конкретные проблемы: неработающие ссылки, путаницу с переименованием файлов (включая скрытые), неясность терминов, неправильный порядок разделов и избыточные шутки, которые мешали пониманию. После каждой сессии он обновлял документацию и проверял её на следующем добровольце. Всего он потратил около €150 на шесть сессий. Автор подчеркивает, что только живой обратная связь от реальных людей — с их эмоциями, контекстом и неожиданными вопросами — может раскрыть слепые зоны, которые не видны ни автору, ни ИИ-моделям. Хотя README ActivityBot ещё не идеален, он стал значительно понятнее. Вывод: разработчикам следует тестировать документацию на людях, даже без оплаты — главное, чтобы они думали вслух. Это делает документацию честнее, полезнее и человечнее.