Артефакт: Материалы поддержки пользователей

Основное описание

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

Этот рабочий продукт обычно включает в себя один или несколько следующих документов и рабочих продуктов:

Руководства пользователя
Руководства по работе
Руководства по обслуживанию
Электронные демонстрации
Электронная справочная система
Контекстная справка
Информация о выпуске

Дополнительная информация

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

Используйте варианты использования в качестве основы для руководства пользователя.

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

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

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

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