Номенклатура показателей качества 12 страница

Допускается исключать вторую стадию разработки, а в технически обоснованных случаях – вторую и третью стадии. Необходимость проведения этих стадий указывается в ТЗ. Разрешается объединять, исключать этапы работ и/или их содержание, а также вводить другие этапы работ по согласованию с заказчиком.

6.5. ГОСТ 19.103. Обозначение программ и программных документов

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

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

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

Структура обозначения программ и ее программного документа – спецификации представлена на рис.6.1.

Рис.6.1. Структура обозначения программ и спецификации

Структура обозначения других программных документов представлена на рис.6.2.

Код страны-разработчика и код организации (предприятия)–разработчика присваивают в установленном порядке.

Рис.6.2. Структура обозначения программ и спецификации

Регистрационный номер присваивают в соответствии с Общесоюзным классификатором программ, утверждаемым Госстандартом в установленном порядке. Регистрационный номер присваивается в порядке возрастания, начиная с 00001 до 99999, для каждой организации-разработчика.

Номер издания программы или номер редакции документа присваивают в порядке возрастания с 01 до 99.

Код вида документа присваивают в соответствии с требованиями ГОСТ 19.101–77.

Номер документа данного вида присваивают в порядке возрастания с 01 до 99.

Номер части одного и того же документа присваивают в порядке возрастания с 1 до 9. Если документ состоит из одной части, то дефис и порядковый номер части не указывают.

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

6.6. ГОСТ 19.105. Общие требования к программным документам

Настоящий стандарт устанавливает общие требования к оформлению программных документов для вычислительных машин, комплексов и систем, независимо от их назначения и области применения и предусмотренных стандартами ЕСПД для любого способа выполнения документов на различных носителях данных.

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

· титульной;

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

· основной;

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

Правила оформления документа и его частей на каждом носителе данных устанавливаются стандартами ЕСПД на правила оформления документов на соответствующих носителях данных.

Титульная часть состоит из листа утверждения и титульного листа. Правила оформления листа утверждения и титульного листа устанавливаются по ГОСТ 19.104–78 (п.6.7).

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

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

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

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

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

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

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

Состав и структура основной части программного документа устанавливаются стандартами ЕСПД на соответствующие документы.

О каждом изменении программного документа в части регистрации изменений делается запись в соответствии с требованиями ГОСТ 19.603.

6.7. ГОСТ 19.104. Основные надписи

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

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

· наименование министерства (ведомства);

· наименование документа;

· обозначение документа;

· сведения о носителе данных, на котором представляется подлинник;

· общее количество листов утверждения, объем документа;

· сведения о разработчике;

· виза нормоконтролера;

· отметка об учете и хранении;

· сведения об изменении.

Лист утверждения выпускается на каждый программный документ на листах бумаги формата А4 независимо от вида документа, который может быть выполнен на любом носителе данных. Обозначение листа утверждения состоит из обозначения документа, к которому относится лист утверждения, и через дефис – шифра ЛУ. Лист утверждения не входит в общее количество листов документа. Лист утверждения вносят в спецификацию после утвержденного документа и хранят на предприятии – держателе подлинника документа. Лист утверждения спецификации также вносят в данную спецификацию. Копии листа утверждения высылают заказчику. Лист утверждения заполняют по форме, приведенной на рис.6.3.

Рис.6.3. Форма листа утверждения

В поле 1 указывают наименование министерства или ведомства, в систему которого входит организация, разработавшая данный документ.

Выше поля 1, в правом верхнем углу, при необходимости ставится специальная отметка (гриф секретности, указания «Для служебного пользования», «С предприятия не выносить» и т.п.).

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

В поле 3 приводят полное наименование программы или программного изделия (прописными буквами), наименование и вид документа. Наименование документа может быть опущено или объединено с наименованием программы.

В поле 4 указывают обозначение документа и указание вида носителя данных. Вид носителя данных указывают только в случае выполнения документа на носителе данных.

В поле 5 указывают общее количество листов утверждения, например, «Листов 3». Для одного листа поле 5 не заполняют.

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

В поле 7 приводят год издания (утверждения) документа (без указания слова «год» или «г»).

Поле 8 содержит отметку об учете и хранении по ГОСТ 19.601–78; поле 9 – строку изменений по ГОСТ 19.604–78; поле 10 – литеру документа.

Пример заполнения листа утверждения приведен на рис.6.4. Количество подписей на листе утверждения приведено условно.

Титульный лист программного документа заполняют по форме и правилам, установленным для листа утверждения, при этом для следующих полей установлены правила:

· поле 1 – заполняют по требованию заказчика;

· поле 2 – не заполняют;

· поле 5 – указывают объем документа;

· поле 6 – не заполняют.

На титульном листе программного документа в левом верхнем углу должна быть надпись, содержащая сведения о соответствующем ему листе утверждения (рис.6.5).

Пример заполнения титульного листа приведен на рис.6.6.

Содержание и правила выполнения основных надписей последующих листов программных документов, выполненных печатным способом, приведены в ГОСТ 19.106.

Рис.6.4. Пример заполнения листа утверждения

Рис.6.5. Надпись на титульном листе

Рис.6.6. Пример заполнения титульного листа

6.8. ГОСТ 19.106. Требования к программным документам, выполненным печатным способом

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

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

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

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

Информационная и основная части программного документа выполняются по форме, представленной на рис.6.7.

Поле 1 содержит порядковый номер страницы, поле 2 – обозначение документа, поле 3 – текст документа, поле 4 – строка изменений.

Рамку формата можно не наносить.

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

Содержание документа размещают на отдельной пронумерованной странице/страницах после аннотации, снабжают заголовком "СОДЕРЖАНИЕ", не нумеруют как раздел и включают в общее количество страниц документа. В содержание документа включают номера разделов, подразделов, пунктов и подпунктов, имеющих заголовок, их наименование и номера страниц. Наименования, включенные в содержание, записывают строчными буквами.

Структурными элементами текста документа являются разделы, подразделы, пункты, подпункты и перечисления:

· раздел – первая ступень деления, обозначенная номером и снабженная заголовком;

· подраздел – часть раздела, обозначенная номером и имеющая заголовок;

· пункт – часть раздела или подраздела, обозначенная номером; может иметь заголовок;

·

подпункт – часть пункта, обозначенная номером; может иметь заголовок.

Рис.6.7. Форма информационной и основной части программного документа

Внутри подразделов, пунктов, подпунктов могут быть даны перечисления, которые рекомендуется обозначать арабскими цифрами со скобкой: 1), 2) и т.д. Допускается выделять перечисления простановкой дефиса перед текстом. Не рекомендуется делать ссылки на элементы перечисления.

Абзац – логически выделенная часть текста, не имеющая номера.

Разрешается помещать текст между заголовками раздела и подраздела, между заголовками подраздела и пункта.

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

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

На рис.6.8 приведен пример структуры текста программного документа и нумерация его разделов, подразделов, пунктов и подпунктов.

Рис.6.8. Структура текста программного документа

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

Термины и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии – общепринятым в научно–технической литературе, и приводиться в перечне терминов.

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

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

Иллюстрации могут быть расположены в тексте документа и/или в приложениях. Иллюстрации нумеруются арабскими цифрами в пределах всего документа. В приложениях иллюстрации нумеруются в пределах приложения. Ссылки на иллюстрации дают по типу: "рис.2" или "(рис.2)". Иллюстрации могут иметь наименование и подрисуночный текст, поясняющий содержание иллюстрации. Их помещают под иллюстрацией, выровняв по центру.

Формулы в документе нумеруются арабскими цифрами, расположив с правой стороны страницы в скобках на уровне формулы. В пределах всего документа формулы имеют сквозную нумерацию. Ссылки в тексте на порядковый номер формулы дают в скобках, например: "в формуле (3)".

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

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

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

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

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

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

6.9. ГОСТ 19.201. Техническое задание. Требования к содержанию и оформлению

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

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

ТЗ оформляют в соответствии с ГОСТ 19.106 на листах формата А4 и при необходимости А3. Номера листов (страниц) проставляются в верхней части листа над текстом. Лист утверждения и титульный лист оформляют в соответствии с ГОСТ 19.104. Информационную часть (аннотацию и содержание), лист регистрации изменений допускается в документ не включать.

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

Техническое задание должно содержать следующие разделы:

· введение;

· основания для разработки;

· назначение разработки;

· требования к программе или программному изделию;

· требования к программной документации;

· технико-экономические показатели;

· стадии и этапы разработки.

В ТЗ допускается включать приложения.

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

В разделе «Введение» указывают наименование, краткую характеристику области применения программы или программного изделия и объекта, в котором используют программу или программное изделие.

В разделе «Основания для разработки» должны быть указаны: документы, на основании которых ведется разработка; организация, утвердившая этот документ, и дата его утверждения; наименование и/или условное обозначение темы разработки.

В разделе «Назначение разработки» должно быть указано функциональное и эксплуатационное назначение программы или программного изделия.

Раздел «Требования к программе или программному изделию» должен содержать следующие подразделы:

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

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

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

· требования к составу и параметрам технических средств (необходимый состав технических средств с указанием их основных технических характеристик);

· требования к информационной и программной совместимости (требования к информационным структурам на входе и выходе и методам решения, исходным кодам, языкам программирования и программным средствам, используемым программой, необходимость обеспечения защиты информации и программ; кроме того, могут указываться протоколы межмашинного сетевого обмена данными, стандарты протоколов формализации данных и управления терминалами, стандарты и форматы сообщений, протоколы транзакций, протоколы запросов данных, стандарты представления данных, требования к СУБД и операционным системам);

· требования к маркировке и упаковке (к маркировке программного изделия, варианты и способы упаковки);

· требования к транспортированию и хранению (для программного изделия условия транспортирования, места хранения, условия хранения, условия складирования, сроки хранения в различных условиях);

· специальные требования.

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

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

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

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

В приложениях к ТЗ, при необходимости, приводят: перечень научно–исследовательских и других работ, обосновывающих разработку; схемы алгоритмов, таблицы, описания, обоснования, расчеты и другие документы, которые могут быть использованы при разработке.

6.10. ГОСТ 19.202. Спецификация. Требования к содержанию и оформлению

Настоящий стандарт устанавливает форму и порядок составления программного документа «Спецификация», определенного ГОСТ 19.101. Спецификация является основным программным документом для компонентов, применяемых самостоятельно, и для комплексов. Для компонентов, не имеющих спецификации, основным программным документом является «Текст программы».

Информационную часть (аннотацию и содержание) допускается в документ не включать.

Форма спецификации приведена на рис.6.9.

Спецификация в общем случае должна содержать разделы:

· документация;

· комплексы;

· компоненты.

Наименование каждого раздела указывают в виде заголовка в графе «Наименование». Для документов, выполненных печатным способом, заголовок подчеркивают.

Рис.6.9. Форма спецификации

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

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

Графы спецификаций заполняют следующим образом:

· в графе «Обозначение» указывают:

¨ в разделе «Документация» – обозначение записываемых документов программы;

¨ в разделе «Комплексы» – обозначение спецификаций комплексов, входящих в данный комплекс;

¨ в разделе «Компоненты» – обозначения основных программных документов компонентов;

· в графе «Наименование» указывают:

¨ в разделе «Документация» – наименование и вид документа для документов на данную программу; полное наименование программы, наименование и вид документа для заимствованных документов;

¨ в разделах «Комплексы» и «Компоненты» – полное наименование программы, наименование и вид документа;

· в графе «Примечание» указывают дополнительные сведения, относящиеся к записанным в спецификации программам.

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

6.11. ГОСТ 19.301. Программа и методика испытаний. Требования к содержанию, оформлению и контролю качества

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

6.11.1. Требования к содержанию

Составление информационной части (аннотации и содержания) является необязательным.

Документ «Программа и методика испытаний» должен содержать следующие разделы:

· объект испытаний;

· цель испытаний;

· требования к программе;

· требования к программной документации;

· средства и порядок испытаний;

· методы испытаний.

В зависимости от особенностей документа допускается вводить дополнительные разделы.

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

В разделе «Цель испытаний» указывают цель проведения испытаний.

В разделе «Требования к программе» указывают требования, подлежащие проверке во время испытаний и заданные в ТЗ на программу, к которым относятся:

· требования устойчивости функционирования ПС при наличии ошибок во входных данных, а именно:

¨ контроль корректности входных данных;

¨ контроль принадлежности входных данных диапазону допустимых значений;

¨ контроль форматов входных данных;

¨ выдача диагностических сообщений пользователю при обнаружении ошибок во входных данных и предпринимаемые действия при обработке ошибок;