Наша речь, как известно, имеет линейную природу. Когда мы говорим, наша речь длится во времени. Когда мы читаем письменный текст, мы фактически имеем дело со словами, выстроенными в один ряд, с отдельными частями текста, следующими одна за другой и т. д. Линейная природа отличает словесный текст, к примеру, от графического изображения, которое, будучи охвачено взглядом, воспринимается скорее синхронно, чем в заданной временной последовательности частей (см. Примечание 1).

Словесный текст как гибкий, универсальный и общедоступный способ подачи информации не имеет никакой равновеликой альтернативы. Эта мысль настолько очевидна, что мы редко обращаем внимание на проблемы, связанные с его линейностью. Между тем, на примере технической документации эти проблемы совершенно очевидны. Программный продукт представляет собой довольно сложную и высокоорганизованную систему, различные элементы которой взаимосвязаны и взаимозависимы. Чтобы изобразить эту систему, лучше всего подошел бы чертеж, и не плоский, а пространственный. Линейный словесный текст попросту не способен наглядно отобразить всю многомерную систему разнонаправленных, переплетающихся друг с другом связей и отношений между частями описываемого объекта (представьте-ка себе, что вместо чертежа какой-нибудь сложной машины перед Вами только ее пространное описание!). Важнейшие аспекты работы программного продукта и периферийные, малозначительные сведения нельзя расположить иерархически, но лишь в механической последовательности, друг за другом, что уравнивает их права на внимание со стороны читателя. Целевой поиск информации в словесном тексте также бывает не слишком удобен.

Мы подробно говорим о несовершенствах словесной формы подачи информации, чтобы Вы лучше представляли, с чем Вам предстоит бороться. Получение и усвоение необходимых сведений о программном продукте из текста документации подчас требует серьезных усилий. Поэтому одним из наших главных правил будет принцип экономии усилий пользователя:

Следуя любому из базовых сценариев (см.  п. 1.2), пользователь должен затрачивать минимум усилий на поиск/получение/усвоение необходимой информации.

Итак, мы сформулировали основной принцип (критерий), в соответствии с которым размещение информации в тексте может рассматриваться как более или менее рациональное. Теперь нам важно сформулировать конкретные рекомендации, следуя которым, можно было бы осуществить этот принцип на практике. Существуют две основные стратегии размещения информации, каждая из которых нацелена в конечном итоге на реализацию принципа экономии усилий. А именно: размещение информации определяется:

• Логикой изложения.
• Соображениями удобства.

Логика изложения детально продумывается на предыдущем этапе работы (см. Главу 2). Размещение информации в соответствии с этой логикой методически правильно и облегчает восприятие и понимание текста пользователем. Однако таким текстом не всегда удобно пользоваться. Иногда, например, пользователю необходимы сведения по какому-то частному вопросу, и он хочет не только без затруднений отыскать эти сведения, но и ознакомиться с ними, не прорабатывая документацию целиком, как прилежный ученик. Или: пользователь хочет вначале ознакомиться с основными приемами работы, не вникая в тонкости и нюансы.

Обычно две стратегии совмещаются. Проще говоря, сведения о программном продукте располагаются отчасти в соответствии с общей логикой изложения, отчасти в соответствии с соображениями удобства.

Примечания

1. Это не мешает нам изучать графическое изображение по частям. Искушенный ценитель живописи разглядывает полотно по частям; чертеж или карта вообще не разглядываются, а "читаются". Когда мы говорим о том, что графическое изображение воспринимается синхронно, мы всего лишь имеем в виду, что все его части даны нам в виде обозримого целого, вне какой-либо навязанной нам временной последовательности; мы же можем, по своему усмотрению, в любой момент обратиться к той или другой из них. При этом, конечно, нам все равно волей-неволей приходится действовать в определенной последовательности, т.к. человек не в состоянии разом воспринять и осмыслить большой объем технической информации (впрочем, обратим внимание на колоссальную эффективность усвоения информации при разглядывании произведений искусства).