Под программным обеспечением обычно понимается некоторая совокупность программных средств, предназначенных для решения определённого круга задач. Программный продукт - это конкретная программа или программный комплекс.
В состав технической документации как правило входят две основные части:
- Руководство пользователя (User's Guide), описание наиболее типичных пользовательских задач, ориентированное в основном на начинающих пользователей.
- Справочник пользователя (User's Reference), полное описание функциональности продукта.
Эти части могут существовать и в интегрированном виде.
Существует несколько сценариев использования документации пользователем:
- "Быстрый старт", т.е. поиск сведений об установке, настройке, запуске и начале работы с программным продуктом.
- Ознакомительное чтение для освоения продукта в целом, решения наиболее типичных задач.
- Целевой поиск путей решения той или иной задачи.
- Целевой запрос справочной информации по избранной функции или элементу интерфейса программы.
- Методическое освоение программного продукта, детальное знакомство со всеми нюансами его работы.
Пользователь вправе рассчитывать, что следуя любому из этих сценариев, он быстро сможет отыскать нужную ему информацию.
