- •Системой контроля версий
- •Модели версионирования
- •Система конкурирующих версий
- •Система Subversion
- •Сценарий объединения правок. Конфликты и способы их разрешения.
- •Утилита nAnt, файл сборки и его структура.
- •Цели, зависимость целей, описание целей.
- •Команды nAnt, примеры команд.
- •Документирование процесса разработки. Типы документов управления.
- •Документирование программного продукта. Документация сопровождения, ее назначение и состав.
- •Документирование программного продукта. Пользовательская документация, ее назначение и состав.
Документирование программного продукта. Пользовательская документация, ее назначение и состав.
Документы, входящие в состав ПС (product documentation), описывают ПС
с точки зрения его применения пользователями,
с точки зрения его разработчиков и сопроводителей (в соответствии с назначением ПС)
Эти документы используются не только на стадии эксплуатации ПС, но и на стадии разработки для управления процессом его разработки
Типы документов продукта
Эти документы образуют два комплекта с разным назначением:
пользовательская документация ПС (П-документация),
документация по сопровождению ПС (С-документация)
Пользовательская документация ПС (user documentation) объясняет пользователям, как они должны действовать, чтобы применить данное ПС
К этому типу документации относятся документы, которыми руководствуется пользователь: при
при инсталляции ПС,
при применении ПС для решения своих задач,
при управлении ПС (например, когда данное ПС взаимодействует с другими системами).
Категории пользователей
Следует различать две категории пользователей ПС:
ординарных пользователей ПС
администраторов ПС
Ординарный пользователь ПС (end-user) использует ПС для решения задач в своей предметной области и может не знать многих деталей работы компьютера или принципов программирования
Категории пользователей
Администратор ПС (system administrator) управляет использованием ПС ординарными пользователями и осуществляет сопровождение ПС, не связанное с модификацией программ
Например, он может
регулировать права доступа к ПС между ординарными пользователями,
поддерживать связь с поставщиками ПС,
выполнять определенные действия для поддержания ПС в рабочем состоянии
Состав документации
Состав пользовательской документации зависит от аудиторий пользователей, на которые ориентировано данное ПС, и от режима использования документов. Пользовательская документация должна содержать информацию, необходимую для каждой аудитории
Режим использования
Под режимом использования документа понимается способ, определяющий, каким образом используется этот документ . Обычно пользователю достаточно больших программных систем требуются либо документы для изучения ПС (использование в виде инструкции), либо для уточнения некоторой информации (использование в виде справочника)
Состав пользовательской документации
Общее функциональное описание ПС с краткой характеристикой функциональных возможностей ПС. Предназначено для пользователей, решающих, насколько необходимо им данное ПС.
Руководство по инсталляции ПС, предназначенное для системных администраторов. Оно должно детально описывать действия по установке системы и определять требования к конфигурации аппаратуры.
Инструкция по применению ПС. Предназначена для ординарных пользователей и содержит необходимую информацию по применению ПС , организованную в форме удобной для изучения
Справочник по применению ПС. Предназначен для ординарных пользователей и содержит необходимую информацию по применению ПС, организованную в форме удобной для избирательного поиска
Руководство по управлению ПС. Предназначено для системных администраторов и должно описывать сообщения, генерируемые при взаимодействии ПС с другими системами, а также способы реагирования на эти сообщения . Если ПС использует системную аппаратуру, то этот документ может объяснять, как сопровождать эту аппаратуру
Разработка пользовательской документации
Разработка пользовательской документации начинается сразу после создания внешнего описания и ее качество может существенно определять успех ПС. Она должна быть достаточно проста и удобна для пользователя, поэтому к созданию их окончательных вариантов часто привлекаются профессиональные технические писатели . Для обеспечения качества пользовательской документации разработан ряд стандартов , в которых
предписывается порядок разработки этой документации,
формулируются требования к каждому виду пользовательских документов,
определяются их структура и содержание