Я заплатил людям, чтобы они попробовали следовать моему README

В недавнем эксперименте разработчик Теренс Иден решил оценить ясность и эффективность своей документации, заплатив людям за то, чтобы они попробовали выполнить инструкции из его файла README. Целью исследования было выявление типичных трудностей, с которыми сталкиваются разработчики при настройке новых программных сред. Наблюдая за участниками, Иден обнаружил, что даже хорошо написанная документация часто не учитывает неявные знания или специфические переменные окружения на компьютере пользователя. Результаты подчеркивают значительный разрыв между тем, как разработчики воспринимают свои инструкции, и тем, как их интерпретируют новички. Иден предлагает сделать «тестирование удобства использования» документации стандартной практикой в разработке открытого ПО, чтобы снизить барьеры для входа. Эксперимент подчеркивает важность создания воспроизводимых сред настройки и ценность внешней обратной связи для совершенствования технической документации, чтобы сделать её доступной для более широкой аудитории.