- •Тема 1. Методология проектирования и модели жизненного цикла программного обеспечения (по)
- •Планирование Анализ риска
- •Тема2.Технологииразработкипрограммного обеспечения
- •Тема 3. Тестирование, отладка, сборка и обеспечение качества по
- •Тема 4. Сопровождение и надежность по
- •Тема 5. Документирование по (семинар)
- •Руководство пользователя по рд 50-34.698-90
- •2. Назначение и условия применения
- •3. Подготовка к работе
- •4. Описание операций
- •5. Аварийные ситуации
- •6. Рекомендации по освоению
- •Тема 6.Стандартизация и метрология в разработке программного обеспечения
- •1.2. Комплексы стандартов на информационные системы
- •Тема 7.Сертификация программного обеспечения
Тема 5. Документирование по (семинар)
1. Принципы и стандарты документирования программного обеспечения.
Внешняя – всевозможные руководства для пользователей, техническое задание, справочники; внутренняя документация – используется в процессе разработки ПО и недоступна конечному пользователю (различные внутренние стандарты, комментарии исходного текста, технологии программирования и т.д.)
Основу отечественной нормативной базы в области документирования ПС составляет комплекс стандартов Единой системы программной документации (ЕСПД). Основная и большая часть комплекса ЕСПД была разработана в 70-е и 80-е годы 20 века.
В РФ действует ряд стандартов в части документирования ПС, разработанных на основе прямого применения международных стандартов ИСО. Это самые «свежие» по времени принятия стандарты. Некоторые из них напрямую адресованы руководителям проекта.
1) ГОСТ Р ИСО/МЭК 9294-93. Информационная технология. Руководство по управлению документированием программного обеспечения. Стандарт полностью соответствует международному стандарту ИСО/МЭК 9294:1990 и устанавливает рекомендации по эффективному управлению документированием ПС для руководителей, отвечающих за их создание. Целью стандарта - оказание помощи в определении стратегии документирования ПС; выборе стандартов по документированию; выборе процедур документирования, определении необходимых ресурсов; составлении планов документирования.
Важно!!! 2) ГОСТ Р ИСО/МЭК 9126-93. Информационная технология. Оценка программной продукции. Характеристики качества и руководства по их применению. Стандарт полностью соответствует международному стандарту ИСО/МЭК 9126:1991. В его контексте под характеристикой качества понимается «набор свойств (атрибутов) программной продукции, по которым ее качество описывается и оценивается».
Стандарт определяет 6 комплексных характеристик, которые с минимальным дублированием описывают качество ПС (ПО, программной продукции):
• функциональные возможности;
• надежность;
• практичность;
• эффективность;
• сопровождаемость;
• мобильность.
Эти характеристики образуют основу для дальнейшего уточнения и описания качества ПС.
3) ГОСТ Р ИСО 9127-94. Системы обработки информации. Документация пользователя и информация на упаковке для потребительских программных пакетов. Стандарт полностью соответствует международному стандарту ИСО 9127:1989.
В контексте стандарта под потребительским программным пакетом (ПП) понимается «программная продукция, спроектированная и продаваемая для выполнения определенных функций; программа и соответствующая ей документация, упакованные для продажи как единое целое».
Под документацией пользователя понимается документация, которая обеспечивает конечного пользователя информацией по установке и эксплуатации ПП.
Под информацией на упаковке понимают информацию, воспроизводимую на внешней упаковке ПП. Ее целью является предоставление потенциальным покупателям первичных сведений о ПП.
4) ГОСТ Р ИСО/МЭК 8631-94. Информационная технология. Программные конструктивы и условные обозначения для их представления. Описывает представление процедурных алгоритмов.
Пока нет лучшего, можно извлекать пользу и из тех стандартов ЕСПД, которые приняты еще около 20 лет назад. Но ясно, что ориентироваться надо на современные стандарты.
Практики сами переводят и используют в своих проектах современные стандарты на организацию ЖЦ ПС и их документирование. Недостатки: разные переводы и адаптации стандартов, сделанные разными разработчиками и заказчиками, будут отличаться массой деталей. Эти отличия неизбежно касаются не только наименований, но и их содержательных определений, вводимых и используемых в стандартах. Т. о., неизбежно постоянное возникновение путаницы, а это прямо противоположно целям стандартов.
Важно!!! 5) ГОСТ Р ИСО/МЭК 12119:1994 (2000). Информационная технология. Пакеты программных средств. Требования к качеству и испытания. В этом стандарте установлены требования к качеству пакетов программ и инструкции по их испытаниям на соответствие заданным требованиям.
2. Стандарты ЕСПД. Документирование стадий разработки, этапов и содержания работ.
Основу отечественной нормативной базы в области документирования ПС составляет комплекс стандартов Единой системы программной документации (ЕСПД). Основная и большая часть комплекса ЕСПД была разработана в 70-е и 80-е годы 20 века.
ГОСТ 19.102-77 ЕСПД. Стадии разработки
Устанавливает стадии разработки программ и программной документации для вычислительных машин, комплексов и систем независимо от их назначения и области применения
Устанавливает стадии разработки программ и программной документации для вычислительных машин, комплексов и систем независимо от их назначения и области применения (табл. 3).
Таблица 3
Стадии разработки, этапы и содержание работ
Стадия разработки |
Этап работы |
Содержание работ |
1. Техническое задание (ТЗ) |
Обоснование необходимости разработки программы |
Постановка задачи. Сбор исходных материалов. Выбор и обоснование критериев эффективности и качества разрабатываемой программы. Обоснование необходимости проведения НИР |
Научно-исследовательские работы (НИР) |
Определение структуры входных и выходных данных. Предварительный выбор методов решения задач. Обоснование целесообразности применения ранее разработанных программ. Определение требований к техническим средствам. Обоснование принципиальной возможности решения поставленной задачи | |
Разработка и утверждение технического задания (ТЗ) |
Определение требований к программе. Разработка ТЭО разработки программы. Определение стадий, этапов и сроков разработки программы и документации на нее. Выбор языков программирования. Определение необходимости проведения НИР на последующих стадиях. Согласование и утверждение ТЗ | |
2. Эскизный проект |
Разработка эскизного проекта |
Предварительная разработка структуры входных и выходных данных. Уточнение методов решения задачи. Разработка общего описания алгоритма решения задачи. Разработка ТЭО |
Утверждение эскизного проекта |
Разработка пояснительной записки. Согласование и утверждение эскизного проекта | |
3. Технический проект |
Разработка технического проекта |
Уточнение структуры входных и выходных данных. Разработка алгоритма решения задачи. Определение формы представления входных и выходных данных. Определение семантики и синтаксиса языка. Разработка структуры программы. Окончательное определение конфигурации технических средств |
Утверждение технического проекта |
Разработка плана мероприятий по разработке и внедрению программ. Разработка пояснительной записки. Согласование и утверждение технического проекта | |
4. Рабочий проект |
Разработка программы |
Программирование и отладка программы |
Разработка программной документации |
Разработка программных документов в соответствии с требованиями ГОСТ 19.101-77 | |
Испытания программы |
Разработка, согласование и утверждение программы и методики испытаний. Проведение предварительных государственных, межведомственных, приемосдаточных и других видов испытаний. Корректировка программы и программной документации по результатам испытаний | |
5. Внедрение |
Подготовка и передача программы |
Подготовка и передача программы и программной документации для сопровождения и (или) изготовления. Оформление и утверждение акта о передаче программы на сопровождение и (или) изготовление. Передача программы в фонд алгоритмов и программ |
Допускается исключать вторую стадию разработки, а в технически обоснованных случаях – вторую и третью стадии. Необходимость проведения этих стадий указывается в техническом задании.
Допускается объединять, исключать этапы работ и (или) их содержание, а также вводить другие этапы работ по согласованию с заказчиком.
3. Документирование ПО. Типовая структура и содержание эксплуатационных документов пользователей ПО.
ГОСТ 19.505-79 ЕСПД. Руководство оператора. Требования к содержанию и оформлению
Руководство оператора должно включать:
1. Назначение программы.
2. Условия выполнения программы.
3. Выполнение программы.
4. Сообщения оператору.
При описании назначений программы необходимо указать сведения о назначении программы и информацию, достаточную для понимания функций программы и ее эксплуатации.
Условия выполнения программы должны содержать условия, необходимые для выполнения программы: минимальный и/или максимальный состав аппаратурных и программных средств.
В разделе Выполнение программы необходимо указать последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы; привести описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды.
При описании сообщений оператору приводят тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора: действия в случае сбоя, возможности повторного запуска программы и т.д.