Создать руководство оператора ПО: описать действия, скриншоты сценария
Для выполнения работы будет предоставлен доступ к демо версии продукта.
Срок: 14 календарных дней.
Требования к документации:
Руководство пользователя (РП) – это информационный документ, который предоставляет пошаговые инструкции (со скриншотами экрана) и информацию о том, как эффективно использовать продукт. РП помогает пользователям понять функции и возможности продукта, а также правильно эксплуатировать данный продукт.
Документ должен содержать информацию которая позволит Пользователям ПО понимать основной функционал программного обеспечения, уметь использовать новые возможности ПО для решения производственных задач в том числе:
- наполнять базы данных ПО необходимой информацией;
- настраивать пользовательский интерфейс ПО «под себя»;
Руководство должно соответствовать требованиям ГОСТ РД 50.34.698.90, в том числе требованиям к качеству и достоверности информации, а также к структуре и оформлению. Формат документа редактируемый, с возможностью сохранять версии, комментарии, замечания (например,
Содержание РП должно быть структурировано по разделам/подразделам. Включать в себя, но не ограничиваться, следующие пункты:
1. Общие положения. Раздел включает в себя термины, обозначение и определения, краткое содержание данной документации, описание цели и области применения руководства, а также перечень документов, которые также необходимо изучить.
2. Общая информация о продукте: для чего создан проект и какие задачи он решает.
3. Основные элементы интерфейса: объяснение предназначения окон, кнопок и других элементов интерфейса.
4. Как эффективно пользоваться программой: описание задач, которые стоят перед пользователем, и способов их решения.
5. Частые вопросы и устранение типовых проблем: информация о проблемах, с которыми часто сталкиваются клиенты, и о путях их решения.
6. Контактная информация: возможность связаться с разработчиком, если руководство не закрывает потребности пользователя.
При написании руководства пользователя необходимо учитывать следующие аспекты:
- Целевая аудитория: рядовые пользователи, диспетчеры общественного транспорта (государственных и муниципальных предприятий).
- Язык и стиль. Изложение ясно и кратко, простым и понятным языком, деловой нейтрально-официальный стиль. Без использования технических терминов и особенно профессионального сленга – жаргона, на котором говорят специалисты.
- Визуальные элементы. Например, скриншоты, схемы и диаграммы, для наглядности, чтобы облегчить понимание и упростить следование инструкциям. На скриншотах выделять кнопки (весь пользовательский сценарий)
- Использовать наглядные примеры.