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

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

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

Говорят, товарищ Сталин, когда один из функционеров пришел к нему с жалобой-доносом на советских писателей, раздраженно заметил: "Других писателей у меня для вас нет".

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

• При ознакомительном чтении документации облегчает усвоение информации пользователем.
• При поиске информации позволяет читать необходимые разделы документации как относительно изолированные фрагменты (не обращаясь за разъяснением каждого понятия к другим разделам).

Отчасти дублирование информации осуществляется естественным порядком как результат изложения "в несколько обходов" (см.  п. 3.2.1). При этом возникает эффект "лекторского" повторения: с каждым разом пользователь все лучше и лучше запоминает и усваивает информацию. Кроме того, типовые процедуры, функции, элементы интерфейса описываются с использованием клише (см.  п. 4.3.2.3). Повторяющееся использование одного и того же описания также некоторым образом обеспечивает многократное дублирование информации.

В то же время дублирование информации порождает определенные проблемы:

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

• Дублирование затрудняет поиск нужных тем, а также создание аппарата для подобного поиска (индекса, системы перекрестных ссылок и т. п.): одна и та же тема фигурирует в разных местах.

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

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

Используйте разные формы отсылки к уже изложенным сведениям:

• Полное воспроизведение
• Сокращенное воспроизведение
• Перекрестная ссылка на соответствующее место

Решение зависит от квалификации пользователя, характера сведений, объема документации и других обстоятельств. В некоторых случаях Вы можете вообще положиться на память и внимание пользователя.

Воспроизводите там, где это только может потребоваться, описания конкретных процедур; реже и только по необходимости - описания функций и возможностей; еще реже - концептуальные рассуждения.

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

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

• Если речь идет о возможности или о функции программного продукта, Вы рассказываете в специальном разделе документации, а впоследствии при необходимости ссылаетесь на этот раздел. К нему же отсылает и индекс.
• Если же речь идет об описании конкретной процедуры поиска: "1. Нажмите на кнопку "Поиск". 2. Введите значения параметров поиска" и т. д., лучше лишний раз повторить в минимальном объеме это пошаговое описание, за подробными пояснениями отослав к специальному разделу. Кроме того, часто бывает так, что процедура поиска включена в другую процедуру, например процедуру привлечения данных для заполнения рабочей ведомости. В этом случае также имеет смысл повторить описание самых необходимых действий и отослать к специальному разделу.

Здесь предложены лишь самые общие рекомендации, какую информацию и в каких количествах имеет смысл дублировать в процессе изложения. Разумеется, и в периодическом повторении одной и той же информации, как уже отмечалось, надо знать меру.

Дублирование информации особенно важно, когда от написания "бумажной" документации Вы переходите к составлению гипертекста для справочной системы. Ведь части гипертекста, к которым обращается справочная система, должны читаться как независимые друг от друга. Поскольку обычно гипертекст создается на основе "бумажного", полезно заранее подготовить почву. Подробнее см. "Гипертекст"*.