Вот несколько причин, почему важно писать хороший README для программного проекта:
- Помогает людям понять, о чём проект. 4 Это обязательное условие для разработки проекта с открытым исходным кодом. 4 Но даже если создаётся закрытая система, следует написать README, чтобы коллеги по проекту могли вникнуть в его суть. 4
- Создаёт хорошее первое впечатление о проекте. 4 Когда кто-то заходит в репозиторий, он первым делом просматривает README-файлы, чтобы получить представление о проекте. 4
- Позволяет продемонстрировать работу другим разработчикам и потенциальным работодателям. 3 Хорошо составленное описание позволяет выделить проект среди других. 3
- Помогает новым участникам быстрее включиться в работу. 2 В README указывают предварительные условия, инструкции по установке и использованию проекта. 2
- Помогает привлечь разработчиков, которые будут вносить вклад в проект. 2 Хороший README просто и наглядно рассказывает о функциях, содержимом и документации, даёт рекомендации тем, кто хочет внести вклад в проект. 2