Разработка справочной системы программного продукта. Создание документации пользователя

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

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

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

У хорошо документированного ПП имеются следующие пре­имущества.

1. Легкость использования. Если ПП хорошо документирован, то его гораздо легче применять. Пользователи его быстрее изуча­ют, делают меньше ошибок, а в результате быстрее и эффектив­нее выполняют свою работу.

2. Меньшая стоимость технической поддержки. Когда пользо­ватель не может разобраться, как выполнить необходимые ему действия, он звонит производителю ПП в службу технической поддержки. Содержание такой службы обходится очень дорого. Хорошее же руководство помогает пользователям решать возни­кающие проблемы самостоятельно и меньше обращаться в группу технической поддержки.

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

4. Легкость сопровождения. Огромное количество денег и вре­мени тратится на анализ проблем, которые порождены ошибка­ми пользователей. Изменения, вносимые в новые выпуски ПП, зачастую являются просто сменой интерфейса старых функций. Они вносятся для того, чтобы пользователи, наконец, разобра­лись, как применять ПП, и перестали звонить в службу техниче­ской поддержки. Хорошее руководство в значительной степени решает эту проблему, плохое же, наоборот, усложняет ее еще больше.

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

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

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

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