Документирование программного продукта. Пользовательская документация, ее назначение и состав

Пользовательская документация ПС объясняет пользователям, как они должны действовать, чтобы применить данное ПС. К этому типу документации относятся документы, которыми руководствуется пользователь при инсталляции ПС, при применении ПС для решения своих задач, при управлении ПС. Состав пользовательской документации зависит от аудиторий пользователей, на которые ориентировано данное ПС, и от режима использования документов. Пользовательская документация должна содержать информацию, необходимую для каждой аудитории.

Состав: •Общее функциональное описание ПС с краткой характеристикой функциональных возможностей ПС. Предназначено для пользователей, решающих, насколько необходимо им данное ПС. •Руководство по инсталляции ПС, предназначенное для сисадминов. Оно должно детально описывать действия по установке системы и определять требования к конфигурации аппаратуры. •Инструкция по применению ПС. Предназначена для ординарных пользователей и содержит необходимую инфу по применению ПС, организованную в форме, удобной для изучения. •Справочник по применению ПС. Предназначен для ординарных пользователей и содержит необходимую инфу по применению ПС, организованную в форме, удобной для избирательного поиска. •Руководство по управлению ПС. Предназначено для сисадминов и должно описывать сообщения, генерируемые при взаимодействии ПС с другими системами, а также способы реагирования на эти сообщения. Если ПС использует системную аппаратуру, то этот документ может объяснять, как сопровождать эту аппаратуру.