Информационное наполнение UNIX

Особенности руководств

Бывают объекты с одинаковыми именами, но принадлежащие разным разделам, например утилита passwd, позволяющая пользователю менять пароль, и файл passwd, в котором хранится учетная запись пользователя (по иронии судьбы в современных версиях UNIX именно пароля там и нет). Для того чтобы посмотреть руководство по passwd из пятого раздела, надо использовать команду man 5 passwd, а если вам неизвестно, к какому разделу относится объект, - man -a passwd (тогда вы увидите руководства по всем объектам с именем passwd ). При ссылке на страницу руководства принято после имени объекта указывать в круглых скобках номер раздела passwd(1) и passwd(5).

В каждом разделе существует специальный объект intro, руководство по которому описывает назначение раздела и определяет основные термины. Кроме того, в поле SEE ALSO этих руководств помещаются ссылки на страницы руководства по крупным темам (например, security(7) ).

Тем не менее сеть страниц руководства - это совсем не учебник по UNIX. Тому есть три причины. Во-первых, учебник - это свод только основных знаний о предмете изучения (отрасли науки, сфере деятельности человека, некотором инструментарии и т. п.) и цель его - донести эти знания в наиболее доступном изложении. Поэтому основную часть учебника занимают вопросы обучающего плана: упражнения, разъяснения, попытки увязать факты в единую схему и т. д. Цель же руководства - сообщить все, что известно об объекте (например, поточном текстовом редакторе sed ), и указать на то, что существует некий предмет рассмотрения, с которым этот объект связан (автоматическая обработка текстов). Причем указание это делается не напрямую, а путем ссылок на иные объекты, тоже относящиеся к делу. Руководство - это справочник; его читают, когда имеют представление о том, что делать, но не знают в точности - как.

Во-вторых, У требует, чтобы при решении некоторой задачи открывающийся информационный контекст был по возможности минимален. Должен быть способ отсекать те области знания, которые не имеют отношения к текущей задаче. И вот с этой точки зрения любые дидактические надстройки над справочником - ненужный шум и, следовательно, вред.

В-третьих, учебникам, "рецептурным книгам" (cookbook) и прочим документам иного формата и назначения в UNIX отведено свое место, поэтому никакой необходимости закладывать все возможные свойства документации в одну подсистему нет.

Смысловая структура системы руководств

Первое, что бросается в глаза, - это ее совершенно естественное происхождение. Трудно поверить, что создатели этой структуры потратили много времени на ее измышление, штудируя труды по эргономике, проектированию систем, гипертекстам и т. д. Кажется, если бы нам самим захотелось разработать систему информационной поддержки, мы бы сделали ее почти такой же. Тем не менее устройство подсистемы руководств носит следы и основ эргономики (правило "7 2", [ 32 ] ), и принципов построения компьютерных систем, а также очевидной гипертекстовой структуры: в страницах руководства есть несколько видов гипертекстовых ссылок. Никаких механизмов перехода по ссылкам в manpages не предусмотрено: предполагается, что, во-первых, сначала лучше дочитать открытое руководство, а во-вторых, если потребуется, всегда можно запустить команду man на соседнем терминальном устройстве (виртуальной консоли или X-терминале). К тому же технически переход по некоторым видам ссылок реализовать не так просто, как это предлагают, скажем, средства просмотра HTML, где используются только контекстные гиперссылки.

Контекстными называются те ссылки, что встречаются внутри текста. Если упоминаемый в руководстве объект имеет собственное руководство, пользователю, возможно, стоит прочесть и его. Для этого, как уже было сказано, после имени объекта ставится в круглых скобках номер раздела, в котором хранится его руководство. Контекстные ссылки не выделяются из текста и почти не мешают чтению, однако именно они задают сеть, связывающую все объекты системы. Расставлять контекстные ссылки надо с осторожностью. Не каждое встреченное имя документированного объекта должно ссылаться на его документацию. Лучше всего превращать объект в контекстную ссылку, только когда читателю действительно может понадобиться соответствующее руководство: при первом упоминании объекта и в тех случаях, когда объект упоминается после продолжительного перерыва или в какой-нибудь иной ипостаси.

Объектные ссылки указывают на реальные объекты системы, например файлы в поле FILES . Этот вид ссылок определяет область действия инструмента, т. е. определяет не смысловую, а актуальную, действующую связь. Объектные ссылки помогают определить список объектов, которые надо скопировать или проверить перед применением соответствующего инструмента, или изучить после воздействия на систему. Это - род концевых ссылок, потому что из информационного пространства рассмотрение переходит в объектное.

Внешние ссылки отсылают к документации, оформленной не в формате manpage. Это может быть учебник, документация в формате info (о ней мы поговорим позже), статья по теме и т. п. Главная особенность внешних ссылок - в том, что за ними стоит по-другому и для другого организованное информационное пространство. Так что нужны они тем читателям, кто ищет в руководстве нечто, ему не свойственное: например, ответ на типовой вопрос. Из типовых вопросов и ответов обычно составляется документ под названием FAQ (frequently asked questions, или часто задаваемые вопросы, ЧаВо), а специфике руководства это не соответствует. Поэтому где-нибудь в поле SEE ALSO должна находиться внешняя ссылка на подобный документ.

Летописными ссылками мы будем называть всякое упоминание не относящихся к предмету рассмотрения объектов: историю создания утилиты, авторов, www-страницу и пр., что встречается чаще всего в полях AUTHORS, HISTORY, AVAILABILITY и т. п. Эти ссылки либо вообще приводятся для удовлетворения любопытства пользователей, либо просто косвенно дополняют описание.

Особую роль в руководстве играет поле SEE ALSO . Состоит оно обыкновенно из информационно нагруженных контекстных или внешних ссылок, список которых целиком остается на совести составителя руководства. Функция поля SEE ALSO заключается в создании контекста вокруг описываемого объекта, или, как было сказано выше, в указании предмета рассмотрения путем перечисления относящихся к делу объектов. Используемые в таком качестве ссылки можно называть предметными . В случае предметных ссылок особенно отчетливо работает О: от того, насколько продуманным будет контекст, зависит не только положение страницы руководства в информационной сети системы, но и состояние и качество самой сети (под "сетью" мы имеем в виду стандартное представление гипертекста в виде узлов-страниц, соединенных ссылками). Неаккуратное оформление руководства может привести к смысловой нестыковке важных частей системы (если мы забыли упомянуть что-то важное), образованию ложной связи (если упомянули что-то не относящееся к делу), зашумлению (если, нарушив У, мы положили в SEE ALSO слишком много наименований) и т. д. Во многих случаях руководство - главный источник актуальной информации об объекте, поэтому, согласно И, чем лучше руководство, тем лучше сам объект, так как он чаще и правильнее используется.