Практика LaTeX для проектной документации: преимущества и результаты | 05 ноября 2013 года, 06:53

Уже третий месяц в проекте у меня используется LaTeX и BitBucket для проектной документации. Устав проекта, планы, протоколы встреч, а главное – спецификация требований ведутся под контролем версий в формате LaTeX.

Весной следующего года планирую написать на Хабру по итогам всего проекта – стоит такой подход затраченных усилий или нет (усилий уходит на инфраструктуру немного).

Что имеем:

1) команда из четырех человек работает с одним и тем же документом.

2) Та же спецификация имеет английскую и русскую версии. Одним кликом готовится или английская, или русская, или совмещенная (в два столбца – как международные договоры).

3) Ведется история версий с самого начала. Понятно, кто что в какой момент добавил и даже иногда зачем.

4) В любой момент каждый член группы может видеть, что конкретно изменилось в документах со любого момента времени в прошлом – например, с момента, когда он видел документ в последний раз.

5) при изменениях документов идет рассылка по группе, что изменение прошло

6) легко автоматически обрабатывать требования скриптами, если понадобится. Например, у меня выгружаются все требования из LaTeX в Excel в формате “Раздел-подраздел-подподраздел-…-IDтребования-требование на рус-требование на англ”. В итоге выходит столько строк, сколько требований. Также выгружаются в упрощенный HTML и в упрощенный Word.

7) итоговый PDF удобен – в нем есть дерево букмарков – по сути содержание, которое понимают все проигрыватели PDF, в нем работают все ссылки (с оглавления на страницы, между страницами, с индекса и др.). Он занимает мало места: спецификация на 40 страниц занимает 400 килобайт, а в ней еще встроены шрифты и есть пара картинок.

Пример исходного текста — на второй фотке. Фрагменты полученных документов – на первой. Там же превью фрагмента.

Оставьте комментарий