Источник: Nuances of Programming Readme  —  это детальное описание проекта. В нем содержится информация о том, что представляет собой проект, кто его авторы, как он устанавливается или настраивается, как используется и прочие данные. Readme  —  визитная карточка проекта. Всякий раз, когда кто-то заходит в репозиторий, он первым делом просматривает readme-файлы, чтобы получить представление о проектах. Детальный readme создает хорошее первое впечатление о проекте. Хотите узнать, как создать впечатляющий...

Будучи разработчиком ПО, я трачу много времени на чтение и написание проектных документов. Прочитав и написав сотни таких документов, я заметила сильную зависимость между качественными проектными документами и окончательным успехом проекта. Эта статья — моя попытка описать, что делает проектный документ действительно хорошим. Зачем пишется проектный документ Проектный документ (также известный как техническая спецификация) — это описание того, как вы планируете решать поставленную перед вами проблему...