В чем преимущества использования отдельного README файла вместо документации внутри кода?

Некоторые преимущества использования отдельного README-файла вместо документации внутри кода:

• Экономия времени, особенно при работе в команде. proglib.io Вместо того чтобы объяснять кодовую базу каждому новому участнику проекта, они могут заранее ознакомиться с документацией, что приведёт к более продуктивному обсуждению. proglib.io
• Поддержка проекта, особенно с открытым исходным кодом. proglib.io С большей вероятностью проект получит поддержку со стороны и будет существовать после того, как его перестанут поддерживать. proglib.io
• Возможность быстрого ревью проекта. vporoshok.me Прочитав один короткий документ, у человека должно сложиться целостное понимание, что перед ним находится, какую задачу решает программа и как её предполагается использовать. vporoshok.me
• Помощь в понимании кода, который был написан несколько лет назад. www.mygreatlearning.com README-файл помогает найти нужный фрагмент кода, что экономит время, когда проблема критична и ограничена по срокам. www.mygreatlearning.com
• Возможность создания walkthrough кода. habr.com Это отдельный документ, в котором можно объяснить, как один фрагмент кода связан с другим, используя ссылки на README или конкретную строку с встроенным комментарием. habr.com