3. Основы стандартизации. Презентация по метрологии и стандартизации.

ДОКУМЕНТИРОВАНИЕ ПРОГРАММНЫХ СРЕДСТВ

• Документы управления разработкой программных средств
• Документы, входящие в состав программных средств

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

Эту документацию можно разбить на две группы:

• Документы управления разработкой ПС.
• Документы, входящие в состав ПС.

Документы управления разработкой ПС

Документы управления разработкой ПС протоколируют процессы разработки и сопровождения ПС, обеспечивая связи внутри коллектива разработчиков и между коллективом разработчиков и менеджерами лицами, управляющими разработкой .

Эти документы могут быть следующих типов:

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

Документы, входящие в состав ПС

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

• Пользовательская документация ПС (П-документация).
• Документация по сопровождению ПС (С-документация).

Пользовательская документация ПС

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

Состав пользовательской документации зависит от аудиторий пользователей, на которые ориентировано данное ПС, и от режима использования документов .

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

Разработка пользовательской документации начинается сразу после создания внешнего описания. Качество этой документации может существенно определять успех ПС. Она должна быть достаточно проста и удобна для пользователя (в противном случае это ПС, вообще, не стоило создавать) .

Документация по сопровождению ПС

Документация по сопровождению ПС (system documentation) описывает ПС с точки зрения ее разработки. Эта документация необходима, если ПС предполагает изучение того, как оно устроена (сконструирована), и модернизацию его программ.

Документация по сопровождению ПС можно разбить на две группы:

• документация, определяющая строение программ и структур данных ПС и технологию их разработки;
• документацию, помогающую вносить изменения в ПС.

Документация является составной частью программного продукта и требуются значительные ресурсы для ее создания и применения.

Тексты и объектный код программ для ЭВМ могут стать программным продуктом только в совокупности с комплексом документов, полностью соответствующих их содержанию и достаточных для его освоения, применения и изменения. Для этого документы должны быть корректными, строго адекватными текстам программ и содержанию баз данных, систематически, структурировано и понятно изложены, для возможности их успешного освоения и использования достаточно квалифицированными специалистами различных рангов и назначения.

Существует большая разница между тем, чтобы просто написать и запрограммировать некоторую функцию для индивидуального использования её разработчиком, и тем, чтобы изготовить её как качественный программный продукт, отчуждаемый от разработчиков, поставляемый заказчику и пользователям.

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

Совокупные затраты на документирование крупных программных продуктов могут достигать 20 – 30% от общей трудоемкости проекта и необходимого числа (десятки) специалистов в жизненном цикле проекта ПС.

Управление документацией  

Управление документацией должно непрерывно поддерживать её полноту, корректность и согласованность с программным продуктом. Адекватность документации требованиям, состоянию текстов и объектных кодов программ должна инспектироваться и удостоверяться (подписываться) ответственными руководителями и заказчиками проекта.

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

Должны быть выделены руководители и коллектив специалистов, которые будут планировать, описывать, утверждать, выпускать, распространять и сопровождать комплекты документов.

Методы и средства документирования в стандартах обычно не раскрываются и адресуются к специальным нормативным документам различного уровня (шаблонам).

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

При создании особо сложных систем целесообразно выделение специального коллектива, обеспечивающего организацию и реализацию основных системных работ по документообороту ПС

По своему назначению и ориентации на определенные задачи и группы пользователей, документацию ПС можно разделить на:

-  технологическую документацию, включающую подробные технические описания, и подготавливаемую для специалистов, ведущих проектирование, разработку и сопровождение комплексов программ, обеспечивающую возможность отчуждения, детального освоения, развития и корректировки ими программ и данных на всем жизненном цикле ПС;

- эксплуатационную документацию – создаваемую для конечных пользователей и позволяющую им осваивать и квалифицированно применять эти средства для решения конкретных функциональных задач систем.

Базой эффективного управления проектом ПС и его документированием должен быть План .

Необходимо также следить за ходом проекта и документирования на всем протяжении жизненного цикла и сравнивать запланированные и фактические результаты работ и документы. При планировании и разработке комплекс документации должен проверяться и аттестовываться на выполнимость и полноту в условиях ограниченных ресурсов, на корректность, адекватность и непротиворечивость отдельных документов.

Сложность документирования, количество и полнота содержания комплекса документов в первую очередь зависят от масштаба – размера проекта ПС

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

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

Должна быть организована служба нормативного контроля, ответственная за соблюдение стандартов, нормативных и руководящих документов при подготовке документации всеми специалистами.

Необходима автоматизированная база данных - информационная система обеспечения и хранения документов проекта 

Аттестация программного средства

Аттестация ПС - это авторитетное подтверждение качества ПС. Для аттестации ПС создается комиссия из экспертов, представителей заказчика и представителей разработчика. Эта комиссия проводит испытания ПС с целью получения необходимой информации для оценки его качества. Испытание ПС - процесс проведения комплекса мероприятий, исследующих пригодность ПС для успешной его эксплуатации и сопровождения в соответствии с требованиями заказчика. Этот комплекс включает проверку полноты и точности программной документации, необходимое тестирование программ, входящих в состав ПС, и, в частности, соответствия этих программ имеющейся документации.