Чтобы ответить на вопрос, для чего составляется документация к программному продукту, необходимо понять, (1) кем, (2) для чего и (3) как она используется.

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

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

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

• Сделает возможным или облегчит ему решение практических задач.

Пример: бухгалтерские программы, текстовые и графические редакторы.

• Существенно расширит круг его возможностей в части решения практических задач.

Пример: издательские системы, базы данных.

• Создаст для него принципиально новую привлекательную сферу деятельности.

Пример: игровые программы, программы для работы в Internet.

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

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

3. Как используется документация? Из сказанного выше очевидно, что она используется для поиска и получения информации. Однако существуют различные сценарии поиска информации, и соответственно, использования документации. Предсказывая возможные варианты поведения пользователя, можно свести эти сценарии к нескольким основным:

• "Быстрый старт", т. е. поиск сведений об установке, настройке, запуске и начале работы с программным продуктом.
• Ознакомительное чтение, дающее возможность освоить работу с продуктом в целом и способы решения наиболее типичных практических задач.
• Целевой поиск путей решения той или иной конкретной практической задачи с помощью продукта.
• Запрос и получение исчерпывающей справочной информации по избранному режиму(ам), элементу(ам) интерфейса, функции(ям) и т. д.
• Детальное знакомство с программным продуктом и нюансами его работы.

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

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

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

Примечания

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