Стоит ли вашей компании внедрять DocBook? Если речь идет об автоматизации труда одного человека — технического писателя, то, пожалуй, нет: проще продолжать работать по-старинке.
Но если компания или организация стремится к прозрачности своих бизнес-процессов, то написание документации становится уделом многих. В основе современных методов контроля качества лежит максима «напиши, что делаешь, делай как написал». Это означает, что значительная часть персонала, вплоть до менеджеров нижнего звена и даже рядовых исполнителей, участвует в документировании процессов управления. К тому же, документирование бизнес-процессов — это не то, что можно один раз поручить внешним консультантам и после этого навсегда зафиксировать. Бизнес-процессы постоянно меняются, что должно отражаться в документации. То есть, мы приходим к уже описанной ситуации «много авторов — один редактор».
Эта же ситуация характерна для ИТ- и консалтинговых компаний, главный актив которых — знания. Где они хранятся, как накапливаются? Худший вариант — в головах сотрудниках, самый распространенный — в файлах Word на персональных компьютерах.
Идеальный — в виде текстов, подготовленных в едином стандарте и помещенных в общее хранилище. Именно этого позволяет добиться DocBook.
Сложно ли внедрить DocBook? По опыту нашей компании, вовлечь в работу широкий круг исполнителей можно достаточно быстро.
Последовательность внедрения:
Подготовьте небольшой документ DocBook, относящийся к вашей предметной области, и раздайте его авторам (или опубликуйте на внутреннем сайте) в качестве образца. Для ввода текста на первых порах можно обойтись обычными текстовыми редакторами.
Определите местоположение документов и порядок совместной работы. Если у вас нет системы контроля версий, начните просто с сетевого диска.
Проинсталлируйте инструментарий XSLT и настройте его так, чтобы получать на выходе документы, оформленные в корпоративном стиле и готовые к публикации на внешнем или внутреннем сайте. Или же подготовленные в соответствии с требованиями заказчика, например с рамками в стиле ГОСТ.