Руководство пользователя
-
Назначение руководства пользователя
- Руководство пользователя помогает пользователям в использовании продукта, услуги или приложения.
- Обычно пишется техническим специалистом, разработчиком или сотрудниками службы поддержки.
-
Содержание руководства пользователя
- Включает титульный лист, предисловие, страницу содержимого, раздел “Назначение”, раздел “Аудитория”, раздел о сфере применения, руководство по использованию, раздел “Устранение неполадок”, FAQ, контактную информацию, глоссарий и указатель.
-
История руководств пользователя
- Древние устройства имели руководства пользователя, например, Антикитерский механизм.
- С развитием программного обеспечения возникали проблемы с документированием.
- Важность использования простого языка, длины и сложности чтения, роли печатных руководств и дизайна, ориентированного на пользователя.
-
Руководства по программному обеспечению для компьютеров
- До появления Unix документация по мэйнфреймам была в виде печатных страниц.
- Современные руководства для ПК и браузеров часто имеют форму книг с аналогичным содержанием.
- Некоторые документы имеют гибкую структуру с внутренними ссылками, например, Руководство пользователя Google Планета Земля.
-
Типы руководств пользователя
- Руководство по установке, Руководство по началу работы, инструкции по эксплуатации.
- В бизнес-приложениях могут быть отдельные руководства для разных групп пользователей.
-
Другие термины и ресурсы
- Руководство по эксплуатации, Примечания к выпуску, Книга Мчс, Технический писатель, Страница руководства (Unix), Руководство по эксплуатации (игровое), Справочная карточка, RTFM (передача данных), Статьи с инструкциями, Рекомендации.