из чего сделаны инструкции
каждому устройству, которое мы разрабатываем и производим, нужно руководство пользователя. инструкции по эксплуатации — это неотъемлемая часть сложного продукта, хотя существует мнение, что пользователи инструкций не читают. раньше в коробку с прибором мы вкладывали довольно толстую книжку, иногда не одну. теперь вместо книжки — компакт-диск, на который записаны pdf-файлы.
как это ни странно, для вёрстки документов мы не используем ни Word, ни QuarkXpress, ни Adobe FrameMaker. возможно, читатель нашего блога знаком с заметками Кати Саковской об особенностях и инструментах для создания руководств пользователя. они посвящены системе компьютерной вёрстки LaTeX, которая помогает нам сделать элегантные и, надеюсь, удобные для чтения документы. впрочем, рекламные материалы тоже удобно создавать в LaTeX’е.
итак, почему для создания инструкций по эксплуатации мы используем LaTeX?
во-первых, формат исходных файлов. он текстовый. да-да, обычный текст, или plain text, как говорят англоязычные товарищи. это значит, что нет проблем с редактированием и с системами контроля версий (svn). кроме того, легко находить и управлять измененими при помощи стандартных инструментов (diff).
во-вторых, автор текста в первую очередь думает о содержании, а не о том, как будет выглядеть страница.
в-третьих, LaTeX легко преобразовать в html для чтения прямо на сайте. но увы, такую возможность мы почему-то не используем, надо это исправить.
ну, и последнее: красивые документы в формате postscript, которые легко вывести на печать и pdf-файлы, удобные для чтения с экрана компьютера.
btw, рекомендую полезную статью «Учите детей Groff’у»» про то, как и зачем отделять содержание текста от внешнего вида. правда, на английском. но есть похожая заметка на русском: «О вреде дружественных интерфейсов».
рекомендую к прочтению.