git головного мозга

Документацию, конечно, лучше хранить в текстовых файлах под контролем какой-нить DVCS.

История: пара товарищей усердно писала пару модулей, взаимодейтсвующих друг с другом. Поскольку предполагалось, что с этими модулями могут взаимодействовать и другие модули, в том числе и сторонних товарищей, то надо писать доку. Дока была написана. С использованием wordpress. Да, который устанавливается, который на php, который работает с БД. Ну, сами понимаете, что написано с использованием редактора wordpress. И все хорошо. Но однажды… тут вспоминаем Брюса Уиллиса из “Счастливого числа Слевина”, который так многозначительно говорил: “Однажды…”.

Так вот, однажды… сервер, где был wordpress, умер. И сисадмины его не восстановили. Они колдовали над своим VMware ESXi, но все тщетно. И документация умерла. Пара товарищей-то, кстати, уже не работала, а желающие использовать модули и узнать какие параметры туда передавать таки были.

А причем тут DVCS? Спросите вы. А при том, что документация редактируемая локально, обычно идет через центральный репозиторий, который обычно не на той машине, что выводит информацию для желающих. Да и редактировать, скорее всего будут несколько человек, в том числе будет иметь локальную копию и руководитель отдела разработки.

В общем, статик-генераторы сайтов типа wintersmith и еже с ним рулят, пишет тестовичек, ложим под гит, пушим на центральный репозиторий, выкатываем на боевую машину.

git головного мозга