Описание: Это самый распространённый вид документации, используемый в процессе обучения персонала новым программным продуктам. Также её называют руководством пользователя.
Данная документация содержит необходимые и достаточные сведения, позволяющие пользователю понять:
* Что представляет собой новая Система, либо изменения в уже имеющемся корпоративном решении; * Как выполнить ту или иную операцию; * Как поступить в случае, если Система ведёт себя нестандартным образом (например, выводит сообщение об ошибке).
В руководстве пользователя важно не только то, что в нём написано, но и как именно изложен материал:
* Если документация нацелена на аудиторию технических специалистов, то и терминология, используемая при её разработке, должна соответствовать данной категории. Например, в этом случае, описание должно быть предельно информативным, но без лишних подробностей и расшифровок; * Если документация разрабатывается для сотрудников, чья профессиональная деятельность связана, например, в большей степени с общением с Клиентами, нежели со сферой IT, то и документация, а особенно пользовательская документация, должна быть предельно доступной. В противном случае пользователь потратит больше времени на расшифровку замысловатых терминов и определений, нежели на изучение непосредственно Системы.
Наша компания стремится к тому, чтобы документация для наших Клиентов соответствовала высокому уровню качества и доступности в изложении, что позволит ей стать "настольной книгой" при изучении новой Системы.