Клуб технических писателей

Разработка документации как кода. Помогите выбрать инструменты.

Добрый день!

В нашей компании хотят перейти к единому источнику документации и внедрить подход Doc As Code.

Какие требования:

  1. Хранить всю информацию в исходниках, написанных на легковесном языке разметки Asciidoc.
  2. Хранить исходники в репозитории в Git.
  3. Из исходников  создать html-файлы и разместить на сайт.
  4. Собрать из нескольких исходников документ, применить к нему стили и сконвертировать в pdf. 

Какие трудности:

  1. Нужен инструмент, который из исходников создаст html-файлы и разместит их на сайт.
  2. Нужен инструмент, который сможет по тегам найти в репозитории определённые исходники и собрать из них документ.  
  3. Нужен инструмент, который к собранному документу применит стили (заранее подготовленный шаблон) и сконвертирует его в pdf.

Помогите, пожалуйста, выбрать инструменты и преодолеть перечисленные трудности.

Мы только в самом начале пути и ещё полны энтузиазма, поэтому активно исследуем форумы/статьи и пр. в поисках наилучших практик. Буду очень благодарна за совет/ссылку/статью по данной теме. А может быть, кто-то поделится собственным опытом и наставит нас на путь истинный).

С уважением, Эльвина

4 комментария
decoy-07
Чтобы изменить шрифт или добавить ссылку, выделите часть текста.
anton.txt@gmail.com
3 марта 2020, 20:58
TexInfo, PanDoc. Естественно, эти инструменты отвечают за документацию, а выкладывать на сайт нужно при помощи других сопряженных программ, например—систем автоматической сборки вроде GNU Make или более новых аналогов.
Если вдруг ещё смогу стать полезным, то вот это решение Вам идеально подходит по описанию. \(゚ー゚\)