Стандартизация программных документов

Согласно ГОСТ 19.106-78* (Общие требования к программным документам, выполненным печатным способом) общие правила для печатного способа выполнения программных документов следующие:

1 Требования не распространяются на программный документ «Текст программы».

2 Программный документ состоит из следующих условных носителей:

- титульной;

- информационной;

- основной;

- регистрации изменений

Информационная часть должна состоять из аннотации и содержания.

В аннотации приводят сведения о назначении документа и краткое изложения его основной части.

Содержание включает перечень записей о структурных документах основной части. Документа, в каждую из которых входят:

- обозначение структурного элемента ( номер раздела. Подраздела и т.п. );

- наименование структурного элемента;

- адрес структурного элемента на носителе данных (например, номер страницы, номер файла и т.п.).

3 Программный документ выполняют на одной стороне листа, через два интервала, допускается через один или полтора интервала.

Программные документы оформляют на листах формата А4 (ГОСТ 2.301-68) – при изготовлении документа машинописным или рукописным способом. Допускается оформление на листах формата А3.

Рисунок 1

Материалы программного документа располагают в следующей последовательности:

- титульная часть:

o лист утверждения (не входит в общее количество листов документа);

o титульный лист (первый лист документа);

- информационная часть:

o аннотация;

o лист содержания;

- основная часть:

o текст документа (с рисунками, таблицами и т.п.);

o приложения;

o перечень терминов, перечень сокращений, перечень рисунков, перечень таблиц, предметный указатель, перечень ссылочных документов;

- часть регистрации изменений:

o лист регистрации изменений.

- Аннотацию размещают на отдельной (пронумерованной) странице с заголовком «АННОТАЦИЯ» и не нумеруют как раздел. В аннотации указывают издание программы, кратко излагают назначение и содержание документа. Если документ состоит из нескольких частей, в аннотации указывают общее количество частей.

- Содержание документа размещают на отдельной (пронумерованной) странице (страницах) после аннотации, снабжают заголовком «СОДЕРЖАНИЕ», не нумеруют как раздел и включают в общее количество страниц документа.

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

- Для разделов и подразделов, текст которых записывают на одной странице с текстом предыдущего раздела, расстояние между последней строкой текста и последующим заголовком должно быть равно трём машинописным интервалам. Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой. В пределах раздела должна быть сквозная нумерация по всем подразделам, пунктам и подпунктам, входящим в данный раздел. Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделённые точкой (2.1; 3.1 и т. д.). При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т.д.). Пример структуры текста программного документа и нумерации его разделов, подразделов, пунктов и подпунктов.

Рисунок 2

4 Текст документа должен быть кратким, четким, исключающим возможность неверного толкования. Термины и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии - общепринятым в научно-технической литературе, и приводиться в перечне терминов. Необходимые пояснения к тексту документа могут оформляться сносками. Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего обреза шрифта, например: «печатающее устройство2)...» или «бумага5)». Если сноска относится к отдельному слову, знак сноски помещается непосредственно у этого слова, если же к предложению целом, то в конце предложения. Текст сноски располагают в конце страницы и отделяют от основного текста линией длиной 3 см, проведённой в левой части страницы.

5 Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа.

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

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

8 В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные. Одно примечание не нумеруется. После слова «Примечание» ставят точку. Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. После слова «Примечание» ставят двоеточие.

9 Сокращения слов в тексте и надписях под иллюстрациями не допускаются.

10 Иллюстрированный материал, таблицы или текст вспомогательного характера допускается оформлять в виде приложений. Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова «ПРИЛОЖЕНИЕ» и иметь тематический заголовок, который записывают симметрично тексту прописными буквами.

Тестирование ПС

Аттестация ПС

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

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

- обработка результатов испытаний (тестирования) (сравнение результатов, полученных испытываемым (тестируемым) ПО, с эталонными).

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

Испытания ПС

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

По согласованию с разработчиком (заказчиком) устанавливается последовательность испытаний ПО с учетом следующих этапов:

1. Проверка документации.

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

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

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

5. Тестирование защищенности ПО и данных (с использованием программных средств, в том числе на основе анализа исходного кода).

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

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

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

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

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

Результаты испытаний ПО признаются положительными, если:

- программа соответствует функциональным возможностям, описанным в документации, и выполняет в рамках тестовых заданий все функции, декларируемые в документации;

- полученные значения параметров и характеристик программы при выполнении всех тестовых заданий удовлетворяют установленным критериям или находятся в допустимых пределах отклонений от них;

- в программе реализованы необходимые методы защиты и идентификации в соответствии с требованиями;

- программная документация соответствует требованиям нормативных документов.

Если в процессе выполнения какого-либо из тестовых заданий произойдет отказ программы, ее «зависание» или искажение результатов, то данное тестовое задание может быть модифицировано для подтверждения ошибки функционирования и повторено. Выявленные ошибки фиксируются в протоколе испытаний.

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

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

Система сертификации программного обеспечения средств измерений и информационно-измерительных систем Правила функционирования

Оценка ПС

Представление всей необходимой документации на аттестацию в соответствии с требованиями рекомендации МИ 2891, а также стандартов ГОСТ Р ИСО/МЭК 12119 и ГОСТ Р ИСО 9127, является необходимым условием ее проведения. Рекомендуемые виды проверки документации применяются при всех степенях жесткости испытаний.

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

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

- наименование модуля;

- функции, реализуемые модулем, и реализованные в модуле алгоритмы;

- данные, используемые и/или изменяемые модулем;

- названия связанных (вызываемых) модулей.

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

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

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

Описание реализованных в ПО расчетных алгоритмов, а также их блок-схемы.

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

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

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

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

Примечания

Некоторые требования к документации в МИ 2891-04 охватывают требования,приведенные в стандартах ГОСТ Р ИСО/МЭК 12119-2000, ГОСТ Р ИСО 9127-94. Поэтому при проверке соответствия документации указанным стандартам, проверяются те требования к документации ПО, которые не регламентируются МИ 2891-04.2 Вся документация ПО проверяется на однозначность понимания и непротиворечивость.

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

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