Интегрированные системы документации

Документация, поставляемая с программой

Некоторые объекты системы не имеют документации ни в формате man, ни в формате info. В этом случае можно надеяться, что при них есть сопроводительная документация, не имеющая, увы, ни стандартного формата, ни тем более ссылок на руководства по другим объектам системы. Такая документация (равно как и примеры использования объекта), обычно помещается в каталог /usr/share/doc/имя_объекта. Как правило, имя объекта здесь — это имя программы и её текущая версия.

Существует ещё одна довольно распространённая ситуация, в которой обширная документация по продукту, расположенная в директории /usr/share/doc/ выходит далеко за рамки man или info — если продукт достаточно сложен и имеет собственную структурированную и очень объёмную документацию. Примерами могут служить веб-сервер Apache или почтовый сервер Postfix.

Широко распространённым видом тематической документации являются HOWTO — статьи, часто объёмом не уступающие книгам, которые посвящены решению какой-либо практической задачи, например Настройка печати или Создание загрузочного диска. Подборки HOWTO могут распространяться вместе с программами, но их также можно найти в Internet. HOWTO могут служить хорошим вводным материалом в целые большие разделы работы с операционной системой и её компонентами. Однако в частностях, которые не относятся к традиционным и устоявшимся основам UNIX, они быстро устаревают и не могут отразить всей специфики разных реализаций UNIX-систем — при чтении HOWTO всегда следует делать на это поправку.

В современных свободных версиях UNIX существуют проекты, целью которых является унификация и систематизация документации на основе XML. Наиболее известный из них — проект Scrollkeeper, который объединяет всю документацию (в первую очередь в современных оконных средах GNOME и KDE) и позволяет просматривать её с помощью простого браузера, предоставляет средства поиска, построения оглавления и указателей, и т. п.

Однако подобные средства документации используются очень ограниченно, а роль основного источника документации в UNIX-системах по-прежнему сохраняют страницы руководства. Возможно, причина этого в «распределённой» природе руководств: нет общего места, где сложены все руководства системы. Напротив, каждое руководство посвящено определённому объекту системы, дает конкретные сведения, необходимые в конкретной ситуации и доступно в любой командной строке, то есть всегда находится «под рукой».

Дата добавления: 2014-01-11