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

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

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

Генератор документации Sandcastle, его назначение и принцип работы

Генератор документации — программа или пакет программ, позволяющая получать документацию, предназначенную для программистов (документация на API) и/или для конечных пользователей системы, по особым образом комментированному исходному коду и/или по исполняемым модулям, полученным на выходе компилятора. Sandcastle имеет 2 основных компонента:

MrefBuilder – генерирует XML-файл, используя механизм отражения; BuildAssembler генерирует файлы, выполняет преобразования и т. д.

MrefBuilder получает информацию из сборки и выдает ее в выходной файл – Reflection.xml; для каждого объекта исходной сборки – пространства имен, класса, свойства, метода и т. п. этот файл содержит свой тэг <api> с подробным описанием. В готовом справочнике каждому тэгу <api> будет соответствовать свой HTML-файл описания. След. шаг: дополнение файла Reflection.xml серией дополнительных тэгов <api>. Для этого используются XSLT-преобразования, которые выполняются утилитой XslTransform. В результате формируется ряд преобразованных .xml файлов, которые подаются на вход компонента BuildAssembler. Справочник и файлы справки, полученные на выходе BuildAssembler и XslTransform, преобразуются в HTML Help при помощи HTML Help Compiler.

Руководство проектом и особенности проектной деятельности

Управление проектом выделяет 2 вида организации человеческой деятельности: операционная и проектная. Условия применимости проектной деят.: разрабатывается новый продукт, внешние условия и требования к продукту постоянно меняются, применяемые производственные технологии используются впервые, постоянно требуются поиск новых возможностей, интеллектуальные усилия и творчество.

Проектная команда, группы и роли в проектной команде

Роли и ответственности участников типового проекта разработки ПО можно условно разделить на пять групп: •Анализ. Извлечение, документирование и сопровождение требований к продукту. •Управление. Определение и управление производственными процессами. •Производство. Проектирование и разработка ПО. •Тестирование. Тестирование ПО. •Обеспечение. Производство дополнительных продуктов и услуг.

Группа анализа: Бизнес-аналитик. Построение модели предметной области. Бизнес-архитектор. Определяет общее видение продукта.

Системный аналитик. Отвечает за перевод требований к продукту в функциональные требования к ПО. Специалист по требованиям. Документирование и сопровождение требований к продукту. Менеджер продукта. Представляет в проекте интересы пользователей продукта. Группа управления: Руководитель проекта. Отвечает за достижение целей проекта при заданных ограничениях. Куратор проекта. Оценка планов и исполнения проекта. Выделение ресурсов. Системный архитектор. Разработка технической концепции системы. Руководитель группы тестирования. Определение целей и стратегии тестирования. Ответственный за управление изменениями, конфигурациями, за сборку и поставку программного продукта. Производственная группа: Проектировщик. Проектирование компонентов и подсистем в соответствие с общей архитектурой, разработка архитектурно значимых модулей. Проектировщик базы данных. Проектировщик интерфейса пользователя. Разработчик. Проектирование, реализация и отладка отдельных модулей системы.

Группа тестирования: Проектировщик тестов. Разработка тестовых сценариев. Разработчик автоматизированных тестов. Тестировщик. Тестирование продукта. Анализ и документирование результатов.

Группа обеспечения: Технический писатель. Дизайнер графического интерфейса. Разработчик учебных курсов, тренер. Продажи и маркетинг. Систадмин. Специалист по инструментальным средствам