Технологии технического авторинга

Довелось мне на днях побывать на собеседовании на должность технического писателя. Естественно, я поинтересовался, как технически построен процесс. А процесс построен следующим образом…

  • Технические писатели делают шаблон в формате MS Word, и отдают его разработчикам (!) для заполнения.
  • После этого переписывают за разработчиками их текст нормальным языком.
  • Версионный контроль за правками отсутствует, версии «хранятся» в именах файлов.
  • В случае необходимости замены большого количества текста вынуждены делать это руками, потому что парсить docx это то ещё удовольствие.

И эта компания много лет на рынке.

Я, скажем мягко, слегка удивился. Какую систему я предлагаю заказчику или работодателю:

  • Система построена на текстовых файлах, хранящихся в репозитории с версионным контролем, ветвлением и прочими положительными сторонами разработки программного продукта.
  • Текстовый формат позволяет отслеживать изменения, а использование регулярных выражений гарантирует как соответствие текста правилам типографики, так и возможность изменить что-то во всех текстах сразу.
  • Документы собираются собственной системой сборки и конвертируются в docx или pdf.

Я для себя выбрал reStructuredText в качестве исходников, его единственный минус том, что нужно написать фильтры для правильной его трансляции в docx.