Обоснование выбора DocBook

После очередного ответа на повторяющиеся вопросы стало, наконец, ясно, что информация есть — её нужно упорядочить и сделать доступной. Для упорядочивания и структурирования информации хорошо подходит формат DocBook. XML — это подмножество SGML и Docbook — тип документа (DTD), разработанный для написания документации. Существуют DTD Docbook для XML и SGML, но выбран именно XML, как более прогрессивный.

Этот формат для документации является аналогом исходных кодов для программ, однажды созданный документ можно преобразовывать в другие форматы, например, html, pdf, rtf, tex, man, dvi, ps и другие. Инструменты обработки DocBook автоматизируют создание индексов, оглавлений, перекрёстных ссылок, включение внешних документов, изменения сущностей средствами языков преобразований (DSSSL и XSL) и многое другое — более детальную информацию можно найти в разделе Информация о DocBook.

Другие предлагавшиеся форматы, например, LaTeX, являются ориентированными на определённое использование и поэтому не подходят для создания универсальной документации. DocBook используется для смысловой разметки текста, поэтому конвертация в него из других форматов недопустима.

Замечание

Документация должна быть корректно написана и структурирована, и НЕ должна ориентироваться на способ публикации, печатный или сетевой.

Существуют гибкие средства преобразования документов в формате DocBook, позволяющие из одного и того же документа получать результаты для разных целей. Например, можно помечать часть текста как общую, часть — как специфичную для ALT Linux Team, и получать как универсальный, так и специфичный для ALT результат. Такой приём называется Profiling. В DocBook стоит создавать только структурированные, продуманные документы, которые будут развиваться и использоваться длительное время, для простых текстов, например, электронных писем, он слишком трудоёмок.