Вопрос 5. Документирование программного обеспечения.

Вопрос 5. Документирование программного обеспечения.

Является обязательным видом работ (вспомогательный процесс). Оформляется документация необходимая для всех заинтересованных лиц, таких как руководство, тех­нические специалисты и пользователи ПО .

Оформляется проектная документация и эксплуа­тационная документация, вид, наименование и комплектность которой устанавливает ГОСТ 34.201-89. Информационная технология. Виды, комплектность и обозначение документов при создании АС.

Эксплуатационная документация на ПО выполняется в рабочем проекте по ГОСТ 19.ХХХ. ЕСПД и включает : "Описание применения" - дает общую характеристику ПО с указанием сферы его применения, требований к базовому ПО, комплексу технических средств; "Руководство пользователя" - включает детальное описание функциональных возможностей и технологии работы с ПО. Данный вид документации ориентирован на конечного пользователя и содержит необходимую информацию для самостоятельного освоения и нормальной работы пользователя (с учетом требуемой квалификации пользователя); "Руководство программиста (оператора)" - указывает особенности установки (инсталляции) ПО и его внутренней структуры, состав и назначение модулей, правила эксплуатации и обеспечения надежной и качественной работы ПО .

В ряде случаев для ПО массового применения, как правило, создаются: автоматизированная контекстно-зависимая помощь ( HELP ); демонстрационные версии, работающие в активном режиме по типу обучающих систем (электронный учебник) или пассивном режиме (ролик, мультфильм) - для демонстрации функциональных возможностей ПО и информационной технологии его использования.

Успех распространения и эксплуатации ПО в значительной степени зависит от качества его эксплуатационной документации, которая выполняется, как правило, не самим разработчиком, а лицом, связанным с распространением и внедрением ПО .

Проектной документацией являются : "Техническое задание" . Оформляется на стадии разработки технического задания в соответствии с требованиями ГОСТ 34.602 - 89. Приводятся общие сведения об объекте автоматизации, назначение, цель создания ПО, требования к системе в целом, к информационному, программному, техническому обеспечению, порядок создания и т.д. В том числе указывается, какая информация вводится в систему, в какой форме, как она должна храниться, какие выходные документы должна система генерировать. Определяются также требования к секретности, уровню защиты информации и многие другие условия, которым система должна удовлетворять. "Техническое задание" может включать смешанные функциональные модели в нотациях IDEF 0 + IDEF 3, DFD + IDEF 3, совместно со словарем данных и миниспецификациями , событийную модель, модель данных в нотации IDEF1; "Пояснительная записка" к эскизному проекту ; документы технического проекта . В самом простом варианте это "Пояснительная записка" по ГОСТ 19.404-79, в разных разделах которой отражаются все результаты технических решений. Например, в разделе "Технические характеристики" приводится описание алгоритма и/или функционирования программы. "Пояснительная записка" может включать смешанную функциональную модель в нотациях DFD + IDEF 3, совместно со словарем данных и миниспецификациями , структурные схемы программ, модель данных ( ERD ), модель пользовательского интерфейса.

В конкретной организации и конкретном проекте вырабатывается стандарт оформления проектной документации (это особенно акту­ально при коллективной разработке ПО большим количеством групп специалистов). Он должен уста­навливать : комплектность, состав и структуру документации на каждой ста­дии создания (например, в соответствии с ГОСТ 34.201-89 . Информационная технология. Виды, комплектность и обозначение документов при создании АС. Зарубежным стандартом на проектную документацию является DOD STD -2167А ); требования к оформлению документации (включая требования к содержанию разделов, подразделов, пунктов, таблиц и т. д.); правила подготовки, рассмотрения, согласования и утвержде­ния документации с указанием предельных сроков для каждой стадии; требования к настройке издательской системы, используемой в качестве встроенного средства подготовки документации; требования к настройке CASE-средств для обеспечения подготов­ки документации в соответствии с установленными правилами.

Для создания документации в процессе разработки ПО используются разнообразные средства формирования отчетов, а также компоненты издательских систем. В них реализована генерация проектной документации по стандартам и ин­ди­видуальным шаблонам, в некоторых имеется возможность русификации отчетов.

Обычно средства документирования встроены в конкретные CASE-средства, особенно в ориентированные на поддержку полного ЖЦ ПО.

Существуют и специализированные средства разработки проектной документации. Из них наиболее активно используется SoDA ( Software Document А utomation ). SoDA позволяет на всех фазах ЖЦ ПО автоматически извлекать разнообразную информацию, получаемую на разных стадиях разработки проекта, и включать ее в выходные документы. При этом контролируется соответствие документации проекту, взаимосвязь документов, обеспечивается их своевременное обновление. Результирующая документация автоматически формируется из множества источников, число которых не ограничено. Изменения автоматически вносятся только в те части документации, инфор­мация для которых была изменена при работе над проектом. Это сокращает время подготовки документации за счет отказа от перегенерации всей документации. SoDA не зависит от применяемых инструментальных средств. Связь с приложениями осуществляется через стандартный программный интерфейс API. Переход на новые инструментальные средства не влечет за собой дополнительных затрат по документированию проекта. SoDA содержит набор шаблонов документов. На их основе можно без специального программирования создавать новые формы документов, определяемые пользователями. Система включает в себя графический редактор для подготовки шаблонов документов. Он позволяет задавать необходимый стиль, фон, шрифт, определять расположение заголовков, резервировать места, где будет размещаться извлекаемая из разнообразных источников информация. Разные виды документации, сопровождающие различные этапы ЖЦ, связаны между собой, и можно проследить состояние проекта от первоначальных требований до анализа, проектирования, кодирования и тестирования ПП. SoDA реализована на базе издательской системы FrameBuilder и предоставляет полный набор средств по редактированию и верстке выпускаемой документации. Итоговым результатом работы системы SoDA является готовый документ (или книга). Документ может храниться в файле формата SoDA ( FrameBuilder ), который получается в результате генерации документа. Вывод на печать этого документа (или его части) возможен из системы SoDA . Среда функционирования SoDA - ОС типа UNIX .

Средство CASE.Аналитик 1.1 - практически единственное в настоящее время конкурентоспособное отечественное CASE-средство функционального моделиро­вания. В нем реализована генерация макетов документов в соответствии с требованиями ГОСТ 19. ххх и ГОСТ 34. ххх . Среда функционирования Windows 9х .