Глава 23. Документация по директориям

В каждой директории проекта должен находиться файл README с описанием следующих моментов:

• Зачем была создана данная директория и что она содержит;

• По строчке описания каждого файла этой директории. Как правило, описание берётся из значения атрибута NAME в заголовке файла;

• Инструкции по сборке и установке;

• Ссылки на связанные источники: директории исходников, online документация, документация на бумажных носителях, документация по разработке;

• И всё, что как-либо может помочь.

Представьте себе, что полгода после ухода последнего из зачинателей проекта в команду приходит новый человек. Этот одинокий и напуганный странник должен по кусочкам собрать и воссоздать полную картину проекта, пройдясь по директориям исходников и прочтя все README, make-файлы и заголовки в файлах исходников.