Опыт применения еспд. Единая система программной документации Виды программных документов
В свое время, когда я только начинал работать программистом, часто приходилось слышать “напиши, пожалуйста, документацию к своей программе”. Я честно все описывал, отдавал начальнику, после чего начинался сеанс черной магии. Начальник через некоторое время меня вызывал и начинал мычать нечленораздельные звуки, мять распечатку моего “самого лучшего” текста в руках, бегая глазами. Общий смысл его мычания заключался в том, что получилось “не то”, “не так”, и “посмотри, как делают другие”. Так как никакого другого ответа из него вытянуть было невозможно, я шел за примерами документов к “другим”. Как правило, это были веселые ребята, смысл речей которых заключался в том, что “вот примеры”, “вообще то по ГОСТу” и “это все никому не нужно”. Так я узнал впервые, что программист может соприкоснуться со страшными ГОСТами.
Поразительно, что среди многих десятков моих коллег, очень неглупых программистов, не было никого, кто бы относился к ГОСТам по другому. Даже те несколько человек, которые их знали и, вроде как, даже умели оформлять документы, относились к ним презрительно-формально. Ситуация, когда даже люди, ответственные за управление разработкой не понимают, зачем нужны ГОСТы и как их применят, встречается на многих предприятиях, сплошь и рядом. Да, были и компании, в которых понимали, чем “Описание программы” отличается от “Описания применения”, но таких было явное меньшинство. В интернете вообще господствует точка зрения, что ГОСТы для программистов - это явный рудимент, и нужны только если “нагибают” под них. Эскизный проект считают “сравнительно честным способом отъемы лишних дензнаков у заказчика”. Вникнуть и разобраться пришлось относительно недавно - в процессе разработки системы управления требованиями, заточенной под отечественную специфику. Документацию которая, разумеется, должна генерировать “по ГОСТу”.
Здесь я хочу сосредоточиться только на одной теме, с которой приходиться иметь дело программисту в отечественных предприятиях, особенно в НИИ - на наборе стандартов ЕСПД. Не считаю себя большим знатоком ЕСПД - есть люди, которые десятки лет по нему работают, и наверняка меня поправят. Статья скорее пытается набросать контуры «дорожной карты» для тех, кто только входит в курс дела.
Стандарты
Рассмотрим кратко, какие бывают стандарты (фокусируясь на ИТ-области).- международные. Отличительный признак - принят международной организацией. Пример такой организации - ISO (международная организация стандартизации). Пример её стандарта: ISO 2382-12:1988 (Переферийное оборудование). Распространены совместные стандарты ISO и международной электротехнической комиссии(IEC, в по русски - МЭК): например, ISO/IEC 12207:2008 (жизненный цикл ПО);
- региональные. Отличительный признак - принят региональной комиссией по стандартизации. К примеру, многие советские ГОСТы сейчас являются региональным стандартом, т.к. приняты межгосударственным советом, куда входят некоторые бывшие советские республики. Этим советом принимаются и новые стандарты - и они тоже получают обозначение ГОСТ. Пример: ГОСТ 12.4.240-2013;
- стандарты общественных объединений; К примеру, той же МЭК: IEC 60255;
- национальные стандарты. Для России в начале таких стандартов - “ГОСТ Р”. Могут быть трех типов:
- точные копии международных или региональных. Обозначаются неотличимо от “самописных” (национальных, написанных самостоятельно);
- копии международных или региональных с дополнениями. Обозначаются добавлением к шифру отечественного стандарта шифра международного, который был взят за основу. Например: ГОСТ Р ИСО/МЭК 12207;
- собственно, национальные стандарты. Например, ГОСТ Р 34.11-94.
Системы обозначений на каждом уровне и в каждой организации свои, для каждого случая придется разбираться отдельно. Чтобы быстро понять, “чей” стандарт перед глазами, можно использовать шпаргалку .
ГОСТ
Итак: стандарты бывают международные, межгосударственные(региональные) и национальные. ГОСТ, как мы выяснили, это региональный стандарт. ГОСТы имеют достаточно запутанную, на мой взгляд, систему обозначений. Полностью она изложена в ГОСТ Р 1.5-2004, я приведу минимум, что бы в ней ориентироваться. Во первых, надо различать обозначение ГОСТа и его классификацию. Обозначение - это, грубо говоря, уникальный идентификатор стандарта. Код по классификатору - это вспомогательный код, помогающий найти стандарт или определить, к какой области знаний он относиться. Классификаторов может быть много, в основном используются два: КГС (классификатор государственных стандартов) и его наследник ОКС (общероссийский классификатор стандартов). Например: “ГОСТ Р 50628-2000“ - это обозначение стандарта.По обозначению понятно только то, что он принят в 2000 году. Он имеет код по ОКС “33.100;35.160”: т.е. “33” - раздел “Телекоммуникации, аудио, видео”, “100” - подраздел “электромагнитная совместимость”. Однако он также входит в ветвь классификатора 35.160. “35” - “Информационные технологии. Машины конторские”, “160” - “Микропроцессорные системы....”. А по КГС он имеет код “Э02”, что означает “Э” - “Электронная техника, радиоэлектроника и связь”, “0” - “Общие правила и нормы по электронной технике, радиоэлектронике и связи”, и т.д.Если известно обозначение стандарта, то получить его коды по КГС и ОКС можно, к примеру, на вот этом толковом сайте .
Итак, вернемся к обозначениям ГОСТов. Их может быть два варианта:
- стандарт относиться к серии стандартов. В этом случае после индекса категории стандарта (например, ГОСТ, ГОСТ Р или ГОСТ РВ) идет код серии, точка и обозначение стандарта внутри серии. Правила обозначения стандартов внутри серии устанавливаются правилами серии. Например: ГОСТ РВ 15.201-2000, ГОСТ Р 22.8.0-99, ГОСТ 19.101-77;
- стандарт не относиться к серии стандартов. Тогда после индекса категории идет просто порядковый номер стандарта, тире и год принятия. Например, ГОСТ Р 50628-2000.
ЕСПД
ЕСПД - одна из таких серий ГОСТов, номер 19. Т.е. все стандарты, относящиеся к ЕСПД, начинаются с префикса “19.”: например, ГОСТ 19.106-78. Расшифровывается как “Единая система программной документации”. Существуют и другие серии:- ГОСТ ЕСКД (единая система конструкторской документации, префикс “2.”);
- ГОСТ ЕСТД (единая система технологической документации, префикс “3.”);
- ГОСТ Р, Система разработки и постановки продукции на производство, префикс “15.”;
- ГОСТ РВ, Вооружение и военная техника. Система разработки и постановки продукции на производство, префикс “15.”;
- ГОСТ, Система технической документации на АСУ, префикс “24.”;
- ГОСТ, Комплекс стандартов на автоматизированные системы, префикс “34.”.
19.001-77. Общие положения
Описывает правила присвоения обозначений стандартов в серии ЕСПД. В практической жизни не нужен.19.102-80. Схемы алгоритмов и программ. Правила выполнения.
Описывает правила построения и оформления алгоритмов. Использует обозначения из 19.103. В моей практике был нужен единственный раз, когда при сертификационная лаборатория уперлась по формальному признаку, что нужна именно схема алгоритма. С моей точки зрения, классические блок-схемы двумя ногами в прошлом, и единственно, где остались более-менее уместными, это если при изложении автор хочет акцентировать внимание читателя именно на алгоритме.19.003-80. Схемы алгоритмов и программ. Обозначения условные графические
Приведены графические обозначения допустимых типов элементов блок-схемы. Нужен, если используются блок-схемы.19.004-80. Термины и определения.
Скудный глоссарий. Из интересного - содержит формальные определения программного и эксплуатационного документов.19.005-85. Р-схемы алгоритмов и программ
Практически забытый язык. В свое время Р-схемы широко использовались в ракетно-космической отрасли, став стандартом де-факто для написания программ управления пусками и моделирования запусков. Однако ныне этот язык полностью предан забвению. В своей работе я ни разу не сталкивался с Р-схемами. Хотя по сравнению с блок-схемами они имеют заметные преимущества: компактны, подходят для визуализации нелинейных алгоритмов (например, классов в С++) или структур данных. При этом в интернете информации по ним практически нет: мне показались полезными вот этот и вот этот сайты. В любом случае, если бы сейчас мне пришлось вставлять в программную документацию схему алгоритма, я бы выбрал Р-схемы, а не блок-схемы.19.101-77. Виды программ и программных документов
Содержит таблицу соответствия вида документа его коду, а также деление видов документов на эксплуатационные и программные. Вводится понятие комплекса и компонента. Больше ничего полезного нет.19.102-77. Стадии разработки
Важный и нужный стандарт, в котором описаны виды документов и приведены коды видов программных документов. Этот стандарт (совместно с 19.103-77) является одним из ключей к “разгадке” обозначений документов подобных АБВГ.10473-01 32 01-1.В стандарте вводится понятие комплекса и компонента (на ряде предприятий добавляют третий вид - комплект, когда речь идет о несвязанных программных элементах), дается разделение: какие документы эксплуатационные, какие нет.
Следует аккуратно относиться к таблице 4, в которой показано, какой документ на какой стадии разработки выполняется. Стадии разработки обычно регламентируются в стандартах на выполнения ОКР, и там-же указывается, какие документы нужно предъявлять заказчику на каждом этапе.
19.102-77. Стадии разработки
На моей памяти этот стандарт не применялся ни разу: кто что делает на каком этапе и чем отчитывается прописывается в ТТЗ или делается отсылка к ГОСТам, где это прописано более четко (например, ГОСТ РВ 15.203). При этом для новичка он содержит неплохой в своей лаконичности конспект работ на основных этапах ОКР.19.103-77. Обозначения программ и программных документов
Нужен, в основном, для того, что бы научиться читать обозначения документов подобных приведенному выше. Однако понимание схемы обозначений полезно в случае, когда приходиться выходить за рамки типовых работ: к примеру, помнить, что документы с кодами после 90 - пользовательские, т.е. любые. В моей практике мы выпускали документ 93, который назвали “Ведомость программной документации”, 96 документ - “Инструкция по сборке”.Распространенное словосочетание “вариант исполнения” в ЕСПД отсутствует, и заменяется “номером редакции”. С одной стороны, это не совсем корректно: номер редакции задумывался для отслеживания эволюции программы: вначале выходит первая редакция, потом, к примеру, после доработки - вторая. Но на практике, когда нужно выпустить версию ПО для нескольких операционных систем (кросс-платформенное ПО), другого выхода нет. Точнее - есть, но неправильный: присвоить версии для каждой операционки свое обозначение - и закладывать в архив несколько дисков с исходниками (по числу операционок), разрабатывать (фактически - копировать) весь комплект документации и т.д… Т.е. чистой воды бестолковая и сбивающая с толку деятельность. Решение в виде присвоения версии под каждую операционку своего номера редакции позволяет часть документов сделать общими.
В ЕСПД используется смущающее многих программистов обозначение исходных текстов программы и результата сборки “документами”. Документ “текст программы”, согласно 19.101-77, имеет обозначение 12. Дальше принято, что исходники обозначаются как 12 01 - т.е. 01(первый) документ вида 12, а бинарники - как 12 02 - т.е. второй документ вида 12. В ряде случаев для сборки программы требуются дополнительные инструментальные средства - компиляторы, генераторы инсталляторов и т.д. Т.е. программы, которые не входят в поставку, но нужны для сборки. Решением может быть их обозначение как 12 03 - т.е. третий документ вида 12.
19.104-78. Основные надписи
Описывает два листа документа - лист утверждения (ЛУ) и титульный лист. Лист утверждения в ЕСПД содержит подписи как начальства, утвердившего документ, так и разработчиков, нормоконтролеров, представителей приемки и т.д. Т.е. на нем присутствует достаточно много чувствительной для предприятия информации. Поэтому в стандарте принято, что ЛУ остается на предприятии-разработчике, и высылается только по особому указанию. Еще раз - ЛУ не является частью документа, а является как бы отдельным документом, и в спецификацию его вносят отдельной строкой.Поначалу смущающая странность в отделении ЛУ от самого документа имеет весьма веские причины:
- как было уже сказано, часто предприятие не хочет раскрывать информацию о разработчике. Отделение ЛУ и его “зажатие” позволяет это сделать (штампа, в отличии от ЕСКД, в ЕСПД на листах документа нет, вся информация локализована только в ЛУ);
- на ряде предприятий используется смешанный документооборот: подлинники документов хранятся в электронном виде в архиве предприятия, а ЛУ на них (с оригиналами подписей) - в бумажном;
Также следует помнить, что ЛУ не нумеруется, и первый лист - титульный, а первый лист, на котором ставится номер - следующий за титульным. Но в том случае, если ЛУ больше одного (это бывает, если все подписи не влезли на лист), то ЛУ нумеруются отдельно.
19.105-78. Общие требования к программным документам
Вводится общая структура документа, не зависящая от способа его исполнения. Т.е. еще в 1978 году было заложено в стандарт, что документ может быть не обязательно бумажным. В частности, вводиться понятие содержания для полностью электронных документов. Для бумажного исполнения, распространенного в то время, был принят ГОСТ 19.106-78.В настоящее время к этому стандарту приходиться обращаться очень редко: разве что забывается порядок следования основных частей документа.
19.106-78. Общие требования к программным документам, выполненным печатным способом
Самый объемный стандарт из ЕСПД, уступающий разве что описанию R-схем. Является основным рабочим стандартом при оформлении документации. Вводит правила оформления текста, элементов структуры документа, изображений, формул и т.д. Однако в отличии от соответствующего 2.106 из ЕСКД, 19.106 существенно менее подробный, что приводит к многочисленным неопределенностям.Во первых, стандарт фактически не определяет межстрочное расстояние и величину вертикальных отступов между заголовками. Он вводит три правила определения интервала: для машинописного текста, машинного и типографского.
Машинописный текст - это текст, набранный на печатной машинке. Смещение следующей строки относительно предыдущей производилось автоматически при так называемом «переводе каретки» - переходе к печати следующей строки, производимым перемещением специального рычага. Как правило, интервал мог быть вручную скорректирован поворотом вала протяжки бумаги, и имел “настройку”, позволяющую задать величину интервала - одинарный или двойной.
Машинный - это, скорее всего, и есть распечатанный текст. Но для него есть только указание, что результат должен быть пригоден для микрофильмирования. Это неявная ссылка на 13.1.002-2003, в котором, к сожалению, задается межстрочный интервал (и, кстати, минимальная высота шрифта) только для рукописных документов (п.4.2.5).
Типографский - текст, набранный в типографии. Учитывая год принятия стандарта, скорее всего речь идет о
[высокой печати , где межстрочный интервал определялся используемыми литерами. Я не специалист в типографском деле, а информации о методах набора сейчас очень мало.
Какой интервал использовать в итоге часто определяется местным нормоконтролем или СТО. Типичные значения - полуторный интервал и 14 размер шрифта.
Часто вызывает много вопросов способ структурирования документа. 19.106 считает, что весь документ делится на разделы, подразделы, пункты и подпункты. У всех них (кроме раздела и подраздела) заголовок может быть и или не быть. При этом:
- “в содержание документа включают номер разделов, подразделов, пунктов и подпунктов, имеющих заголовок” (п. 2.1.4). Это прямое указание на то, что подпункт может иметь заголовок и включаться в оглавление;
- “допускается помещать текст между заголовками раздела и подраздела, между заголовками подраздела и пункта”. Важно обратить внимание, что ненумерованный текст может быть только между заголовками, и только на верхних 2х уровнях.
Этот стандарт имеет ряд “дыр”, недостказанностей. К примеру, сказано: “иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа. “ Но если иллюстрация одна, то она ненумерованная, и как тогда на нее ссылаться? Аналогично и для таблиц. Для сносок ГОСТ не указывает способ их нумерации - в пределах всего документа или в пределах страницы.
Таблицы. В самом документе дана ссылка на ГОСТ 1.5.68. Судя по первой серии, несложно заключить, что это стандарт на разработку стандартов. Причем тут он, неясно. По смыслу он соответствует правилам оформления таблиц в ЕСКД, с небольшими исключениями. Этот стандарт был отменен, взамен веден, через несколько итераций, 1.5-2012, в котором правила оформления таблицы… просто исчезли. Еще в 1.5-2002 были, а уже в 1.5-2004 исчезли. В реальной жизни мы оформляем таблицы согласно ЕСКД.
Приложения. Стандарт не указывает, попадают ли рисунки, формулы и таблицы из приложений в общий перечень. Аналогично не сказано, нужно ли в оглавлении раскрывать структуру приложения, если оно содержит свои разделы, пункты и т.д. В нашей практике мы не раскрываем внутренности приложений.
Наконец, следует сказать об отступах. Абзацный отступ, равный 5 символам, является общим для:
- красной строки;
- отступа элемента структуры документа после раздела (подраздел, пункт, подпункт);
- элемент перечисления.
При этом текст, расположенный на следующей строку после строки с отступом, выравнивается уже по левому полю. Часто встречаются ошибки, когда отступ скачет - красная строка - одно значение, номер пункта - нас другим интервалом, в вложенные отступы в списках - так вообще обязательно.
В следующих частях планирую уже добраться до конца списка стандартов ЕСПД.
И программной документации.
В стандартах ЕСПД устанавливают требования, регламентирующие разработку, сопровождение, изготовление и эксплуатацию программ, что обеспечивает возможность:
- унификации программных изделий для взаимного обмена программами и применения ранее разработанных программ в новых разработках;
- снижения трудоемкости и повышения эффективности разработки, сопровождения, изготовления и эксплуатации программных изделий;
- автоматизации изготовления и хранения программной документации.
Сопровождение программы включает анализ функционирования, развитие и совершенствование программы, а также внесение изменений в нее с целью устранения ошибок.
Перечень стандартов, входящих в ЕСПД
- ГОСТ 19.001-77. ЕСПД. Общие положения.
- ГОСТ 19.003-80. ЕСПД. Схемы алгоритмов и программ. Обозначения условные графические.
- ГОСТ 19.005-85. ЕСПД. Р-схемы алгоритмов и программ. Обозначения условные графические и правила выполнения.
- ГОСТ 19.101-77. ЕСПД. Виды программ и программных документов.
- ГОСТ 19.102-77. ЕСПД. Стадии разработки.
- ГОСТ 19.103-77. ЕСПД. Обозначение программ и программных документов.
- ГОСТ 19.104-78. ЕСПД. Основные надписи.
- ГОСТ 19.105-78. ЕСПД. Общие требования к программным документам.
- ГОСТ 19.106-78. ЕСПД. Требования к программным документам, выполненным печатным способом.
- ГОСТ 19.201-78. ЕСПД. Техническое задание. Требования к содержанию и оформлению.
- ГОСТ 19.202-78. ЕСПД. Спецификация. Требования к содержанию и оформлению.
- ГОСТ 19.301-79. ЕСПД. Программа и методика испытаний. Требования к содержанию и оформлению.
- ГОСТ 19.401-78. ЕСПД. Текст программы. Требования к содержанию и оформлению.
- ГОСТ 19.402-78. ЕСПД. Описание программы.
- ГОСТ 19.403-79. ЕСПД. Ведомость держателей подлинников.
- ГОСТ 19.404-79. ЕСПД. Пояснительная записка. Требования к содержанию и оформлению.
- ГОСТ 19.501-78. ЕСПД. Формуляр. Требования к содержанию и оформлению.
- ГОСТ 19.502-78. ЕСПД. Описание применения. Требования к содержанию и оформлению.
- ГОСТ 19.503-79. ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению.
- ГОСТ 19.504-79. ЕСПД. Руководство программиста. Требования к содержанию и оформлению.
- ГОСТ 19.505-79. ЕСПД. Руководство оператора. Требования к содержанию и оформлению.
- ГОСТ 19.506-79. ЕСПД. Описание языка. Требования к содержанию и оформлению.
- ГОСТ 19.507-79. ЕСПД. Ведомость эксплуатационных документов.
- ГОСТ 19.508-79. ЕСПД. Руководство по техническому обслуживанию. Требования к содержанию и оформлению.
- ГОСТ 19.601-78. ЕСПД. Общие правила дублирования, учета и хранения.
- ГОСТ 19.602-78. ЕСПД. Правила дублирования, учета и хранения программных документов, выполненных печатным способом.
- ГОСТ 19.603-78. ЕСПД. Общие правила внесения изменений.
- ГОСТ 19.604-78. ЕСПД. Правила внесения изменений в программные документы, выполненные печатным способом.
- ГОСТ 19.701-90 (ИСО 5807-85). ЕСПД. Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения.
См. также
Ссылки
Wikimedia Foundation . 2010 .
Смотреть что такое "Единая система программной документации" в других словарях:
- (ЕСКД) комплекс государственных стандартов, устанавливающих взаимосвязанные правила, требования и нормы по разработке, оформлению и обращению конструкторской документации, разрабатываемой и применяемой на всех стадиях жизненного цикла … Википедия
система - 4.48 система (system): Комбинация взаимодействующих элементов, организованных для достижения одной или нескольких поставленных целей. Примечание 1 Система может рассматриваться как продукт или предоставляемые им услуги. Примечание 2 На практике… …
РД 153-34.1-35.521-00: Методические указания. Состав и ведение эксплуатационной документации в цехах АСУ ТП (ТАИ) тепловых электростанций - Терминология РД 153 34.1 35.521 00: Методические указания. Состав и ведение эксплуатационной документации в цехах АСУ ТП (ТАИ) тепловых электростанций: 1. Автоматизированная система управления технологическими процессами (АСУ ТП) Система… … Словарь-справочник терминов нормативно-технической документации
- (ЭИС) представляет собой совокупность организационных, технических, программных и информационных средств, объединённых в единую систему с целью сбора, хранения, обработки и выдачи необходимой информации, предназначенной для выполнения функций… … Википедия
ЕСПД - Единая система программной документации … Словарь сокращений русского языка
Единая система программной документации (ЕСПД) комплекс государственных стандартов, устанавливающих взаимосвязанные правила разработки, оформления и обращения программ и программной документации. В стандартах ЕСПД устанавливают требования,… … Википедия
- (ТЗ, техзадание) исходный документ для разработки и испытания изделия. Содержание 1 Понятие ТЗ 2 Место ТЗ в структур … Википедия
эксплуатационная документация - 30 эксплуатационная документация Документация на опалубку, выполненная в соответствии с требованиями ГОСТ 2.601 95 (паспорт, инструкция по эксплуатации и др.)
Комплекс стандартов на автоматизированные системы (КСАС)
Единая система программной документации (ЕСПД) - отечественный комплекс стандартов на программную документацию . В профессиональном просторечии его еще называют «девятнадцатым гостом» , что не совсем правильно, поскольку речь идет не об одном, а примерно о 30 разных нормативно-технических документах.
В основном стандарты ЕСПД содержат требования к составу, содержанию и оформлению документов, описывающих программу на разных стадиях ее жизненного цикла. Кроме того, несколько документов посвящено порядку хранения и обновления документации.
Стандарты ЕСПД практически лишены методической составляющей. Они не объясняют разработчику, как надо писать документацию, чтобы она получилась полезной, понятной, информативной, удобной и т. д. Они дают только перечень типов документов и список разделов первого уровня для каждого из них. Правда, о каждом разделе сказано, какие сведения должны быть в нем изложены.
Стандарты ЕСПД были приняты в конце 70-х годов и дошли до нас в виде, близком к первоначальному. В них отражена практика работы ведомственных вычислительных центров, где эксплуатировались большие ЭВМ. Взаимодействие человека с компьютерной системой тогда было построено совсем не так, как теперь, и осуществлялось через громоздкие пульты, перфокарты и распечатки, а для «простых смертных», решающих прикладные задачи, еще и при посредничестве квалифицированного персонала. Надо ли долго объяснять, насколько эти стандарты к настоящему времени устарели? Достаточно сказать, что им неведомы такие распространенные сегодня документы, как руководство пользователя и руководство администратора .
И все-таки ими продолжают активно пользоваться. Формально «девятнадцатому» есть современная альтернатива. Переведены на русский язык и приняты в России на правах национальных некоторые стандарты ИСО/МЭК в области системной и программной инженерии . Но крупные, в том числе, государственные заказчики переходить на них не торопятся. Это можно объяснить их косностью (или верностью традиции, как вам больше нравится), но лишь отчасти.
Дело в том, каждый стандарт ЕСПД при небольшом (страницы три максимум) объеме представляет собой набор довольно формальных и поэтому легко проверяемых требований к документу или к комплекту документации. Строго говоря, это не мешает разработчику документации писать правильно оформленные глупости. Но поскольку ЕСПД четко определяет, из чего должен состоять и как должен выглядеть результат, мы можем, по крайней мере, сразу отклонить пачку бумаги, которая в эти рамки не вписывается. Что существенно упрощает задачу сдачи-приемки документации как для заказчика, так и для исполнителя.
Стандарты ИСО/МЭК, напротив, содержат много разумных правил содержательного характера, но сложно представить себе процедуру их формальной проверки. Впрочем, никто не мешает применять оба ряда стандартов одновременно, благо, они касаются разных аспектов документирования и друг другу практически не противоречат.
Состав нормативно-технических документов
| Обозначение | Наименование |
| ГОСТ 19.001-77 | Общие положения |
| ГОСТ 19.002-80 | Единая система программной документации. Схемы алгоритмов и программ. Правила выполнения |
| ГОСТ 19.004-80 | Единая система программной документации. Термины и определения |
| ГОСТ 19.005-85 | Единая система программной документации. Р-схемы алгоритмов и программ. Обозначения условные графические и правила выполнения |
| ГОСТ 19.101-77 | Единая система программной документации. Виды программ и программных документов |
| ГОСТ 19.102-77 | Единая система программной документации. Стадии разработки |
| ГОСТ 19.103-77 | Единая система программной документации. Обозначение программ и программных документов |
| ГОСТ 19.104-78 | Единая система программной документации. Основные надписи |
| ГОСТ 19 105-78 | Единая система программной документации. Общие требования к программным документам |
| ГОСТ 19.106-78 | Единая система программной документации. Требования к программным документам, выполненным печатным способом |
| ГОСТ 19.201-78 | Единая система программной документации. Техническое задание |
| ГОСТ 19.202-78 | Единая система программной документации. Спецификация. Требования к содержанию и оформлению |
| ГОСТ 19.301-79 | Единая система программной документации. Программа и методика испытаний. Требования к содержанию и оформлению |
| ГОСТ 19.401-78 | Единая система программной документации. Текст программы. Требования к содержанию и оформлению |
| ГОСТ 19.402-78 | Единая система программной документации. Описание программы |
| ГОСТ 19 403-79 | Единая система программной документации. Ведомость держателей подлинников |
| ГОСТ 19.404-79 | Единая система программной документации. Пояснительная записка. Требования к содержанию и оформлению |
| ГОСТ 19.501-78 | Единая система программной документации. Формуляр. Требования к содержанию и оформлению |
| ГОСТ 19.502-78 | Единая система программной документации. Описание применения . Требования к содержанию и оформлению |
| ГОСТ 19.503-79 | Единая система программной документации. Руководство системного программиста . Требования к содержанию и оформлению |
| ГОСТ 19.504-79 | Единая система программной документации. Руководство программиста |
| ГОСТ 19.505-79 | Единая система программной документации. Руководство оператора . Требования к содержанию и оформлению |
| ГОСТ 19.506-79 | Единая система программной документации. Описание языка . Требования к содержанию и оформлению |
| ГОСТ 19.507-79 | Единая система программной документации. Ведомость эксплуатационных документов |
| ГОСТ 19.508-79 | Единая система программной документации. Руководство по техническому обслуживанию. Требования к содержанию и оформлению |
| ГОСТ 19.601-78 | Единая система программной документации. Общие правила дублирования, учета и хранения |
| ГОСТ 19.602-78 | Единая система программной документации. Правила дублирования, учета и хранения программных документов, выполненных печатным способом |
| ГОСТ 19.603-78 | Единая система программной документации. Общие правила внесения изменений |
| ГОСТ 19.604-78 | Единая система программной документации. Правила внесения изменений в программные документы, выполненные печатным способом |
Приобретение стандартов
ГОСТ 19.001-77 Общие положения
ГОСТ 19781-90 Термины и определения.
ГОСТ 19.101-77 Виды программ и программных документов
ГОСТ 19.102-77 Стадии разработки
ГОСТ 19.103-77 Обозначения программ и программных документов
ГОСТ 19.104-78 Основные надписи
ГОСТ 19.105-78 Общие требования к программным документам
ГОСТ 19.106-78 Требования к программным документам, выполненным печатным способом
ГОСТ 19.201-78 Техническое задание, требования к содержанию и оформлению
ГОСТ 19.202-78 Спецификация. Требования к содержанию и оформлению
ГОСТ 19.301-79 Программа и методика испытаний. Требования к содержанию и оформлению
ГОСТ 19.401-78 Текст программы. Требования к содержанию и оформлению
ГОСТ 19.402-78 Описание программы
ГОСТ 19.403-79 Ведомость держателей подлинников
ГОСТ 19.404-79 Пояснительная записка. Требования к содержанию и оформлению
ГОСТ 19.501-78 Формуляр. Требования к содержанию и оформлению
ГОСТ 19.502-78 Описание применения. Требования к содержанию и оформлению
ГОСТ 19.503-79 Руководство системного программиста. Требования к содержанию и оформлению
ГОСТ 19.504-79 Руководство программиста. Требования к содержанию и оформлению ГОСТ 19.505-79 Руководство оператора. Требования к содержанию и оформлению
ГОСТ 19.506-79 Описание языка. Требования к содержанию и оформлению
ГОСТ 19.507-79 Ведомость эксплуатационных документов
ГОСТ 19.508-79 Руководство по техническом обслуживанию. Требования к содержанию и оформлению
ГОСТ 19.601-78 Общие правила дублирования, учета и хранения
ГОСТ 19.602-78 Правила дублирования, учета и хранения программных документов, выполненных печ. способом
ГОСТ 19.603-78 Общие правила внесения изменений
ГОСТ 19.604-78 Правила внесения изменений в программные документы, выполненных печатным способом
ТЕХНИЧЕСКОЕ ЗАДАНИЕ.
ТРЕБОВАНИЯ К СОДЕРЖАНИЮ И ОФОРМЛЕНИЮ
ГОСТ 19.201-78
с 01.01. 1980 г.
Настоящий стандарт устанавливает порядок построения и оформления технического задания на разработку программы или программного изделия для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
Стандарт полностью соответствует СТ СЭВ 1627-79.
1. ОБЩИЕ ПОЛОЖЕНИЯ
1.1. Техническое задание оформляют в соответствии с ГОСТ 19.106-78 на листах формата 11 и 12 по ГОСТ 2.301-68, как правило, без заполнения полей листа. Номера листов (страниц) проставляются в верхней части листа над текстом.
1.2. Лист утверждения и титульный лист оформляют в соответствии с ГОСТ 19.104-78.
Информационную часть (аннотацию и содержание), лист регистрации изменений допускается в документ не включать.
1.3. Для внесения изменений или дополнений в техническое задание на последующих стадиях разработки программы или программного изделия выпускают дополнение к нему. Согласование и утверждение дополнения к техническому заданию проводят в том же порядке, который установлен для технического задания.
1.4. Техническое задание должно содержать следующие разделы:
введение;
· основания для разработки;
· назначение разработки;
· требования к программе или программному изделию;
· требования к программной документации;
· технико-экономические показатели;
· стадии и этапы разработки;
· порядок контроля и приемки;
· в техническое задание допускается включать приложения.
В зависимости от особенностей программы или программного изделия допускается уточнять содержание разделов, вводить новые разделы или объединять отдельные из них.
2.1. В разделе «Введение» указывают наименование, краткую характеристику области применения программы или программного изделия и объекта, в котором используют программу или программное изделие.
(Измененная редакция, Изм. № 1)
2.2. В разделе «Основания для разработки» должны быть указаны:
· документ (документы), на основании которых ведется разработка;
· организация, утвердившая этот документ, и дата его утверждения;
· наименование и (или) условное обозначение темы разработки.
(Измененная редакция, Изм. № 1)
2.3. В разделе «Назначение разработки» должно быть указано функциональное и эксплуатационное назначение программы или программного изделия.
2.4. Раздел «Требования к программе или программному изделию» должен содержать следующие подразделы:
· требования к функциональным характеристикам;
· требования к надежности;
· условия эксплуатации;
· требования к составу и параметрам технических средств;
· требования к информационной и программной совместимости;
· требования к маркировке и упаковке;
· требования к транспортированию и хранению;
· специальные требования.
(Измененная редакция, Изм. № 1)
2.4.1. В подразделе «Требования к функциональным характеристикам» должны быть указаны требования к составу выполняемых функций, организации входных и выходных данных, временным характеристикам и т. п.
2.4.2. В подразделе «Требования к надежности» должны быть указаны требования к обеспечению надежного функционирования (обеспечения устойчивого функционирования, контроль входной и выходной информации, время восстановления после отказа и т.п.).
2.4.3. В подразделе «Условия эксплуатации» должны быть указаны условия эксплуатации (температура окружающего воздуха, относительная влажность и т.п. для выбранных типов носителей данных), при которых должны обеспечиваться заданные характеристики, а также вид обслуживания, необходимое количество и квалификация персонала.
2.4.4. В подразделе «Требования к составу и параметрам технических средств» указывают необходимый состав технических средств с указанием их основных технических характеристик.
2.4.5. В подразделе «Требования к информационной и программной совместимости» должны быть указаны требования к информационным структурам на входе и выходе и методам решения, исходным кодам, языкам программирования и программным средствам, используемым программой.
При необходимости должна обеспечиваться защита информации и программ.
(Измененная редакция, Изм. № 1)
2.4.6. В подразделе «Требования к маркировке и упаковке» в общем случае указывают требования к маркировке программного изделия, варианты и способы упаковки.
2.4.7. В подразделе «Требования к транспортированию и хранению» должны быть указаны для программного изделия условия транспортирования, места хранения, условия хранения, условия складирования, сроки хранения в различных условиях.
2.5а. В разделе «Требования к программной документации» должен быть указан предварительный состав программной документации и, при необходимости, специальные требования к ней.
(Введен дополнительно, Изм. № 1).
2.5. В разделе «Технико-экономические показатели» должны быть указаны: ориентировочная экономическая эффективность, предполагаемая годовая потребность, экономические преимущества разработки по сравнению с лучшими отечественными и зарубежными образцами или аналогами.
2.6. В разделе «Стадии и этапы разработки» устанавливают необходимые стадии разработки, этапы и содержание работ (перечень программных документов, которые должны быть разработаны, согласованы и утверждены), а также, как правило, сроки разработки и определяют исполнителей.
2.7. В разделе «Порядок контроля и приемки» должны быть указаны виды испытаний и общие требования к приемке работы.
2.8. В приложениях к техническому заданию, при необходимости, приводят:
перечень научно-исследовательских и других работ, обосновывающих разработку;
схемы алгоритмов, таблицы, описания, обоснования, расчеты и другие документы, которые могут быть использованы при разработке;
другие источники разработки.
ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ,
ВЫПОЛНЕННЫМ ПЕЧАТНЫМ СПОСОБОМ
ГОСТ 19.106-78
1.5. Программные документы оформляют:
на листах формата А4 (ГОСТ 2.301-68) - при изготовлении документа машинописным или рукописным способом (форма 1). Допускается оформление на листах формата А3 (форма 2);
на листах форматов А4 и А3, предусматриваемых выходными характеристиками устройств вывода данных - при изготовлении документа машинным способом. Допускаются отклонения размеров листов, соответствующих форматам А4 и А3, определяемые возможностями применяемых технических средств;
на листах типографических форматов - при изготовлении документа типографским способом.
Материалы программного документа располагают в следующей последовательности:
титульная часть:
§ лист утверждения (не входит в общее количество листов документа);
§ титульный лист (первый лист документа);
§ информационная часть:
§ аннотация;
§ основная часть:
§ текст документа (с рисунками, таблицами и т.п.);
§ приложения;
§ перечень терминов;
§ перечень сокращений;
§ перечень рисунков;
§ перечень таблиц;
§ предметный указатель;
§ перечень ссылочных документов;
§ перечень символов и числовых коэффициентов;
§ часть регистрации изменений:
§ лист регистрации изменений.
Приложения, перечни терминов, сокращений, рисунков и таблиц, предметных указатель, перечни ссылочных документов, символов и числовых коэффициентов выполняются при необходимости.
(Измененная редакция, Изм. № 1)
1.7. Перечни терминов и сокращений, предметный указатель, перечень символов и числовых коэффициентов следует составлять в алфавитном порядке.
Остальные перечни составляют в порядке возрастания номеров.
(Введен дополнительно, Изм. № 1)
2. ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ, СОДЕРЖАЩИМ В ОСНОВНОМ СПЛОШНОЙ ТЕКСТ.
2.1. Построение документа.
2.1.1. При необходимости допускается делить документ на части. Деление на части осуществляется на уровне не ниже раздела. Каждую часть комплектуют отдельно. Всем частям присваивают обозначение документа в соответствии с ГОСТ 19.103-77.
Части оформляют в соответствии с требованиями настоящего стандарта, при этом в конце содержания первой части следует перечислять названия остальных частей.
Допускается включать в документ частей текста программы, оформляемых в соответствии с правилами языка, на котором написан текст программы.
Нумерацию страниц документа, а также нумерацию разделов, рисунков и таблиц производят в пределах каждой части. Каждую часть начинают с титульного листа.
Отдельная нумерация страниц документа в пределах раздела и подраздела не допускается.
Лист утверждения выпускают на весь документ с обозначением первой части.
2.1.2. Информационная и основная части программного документа выполняются по форме 1 или 2, где:
поле 1 - порядковый номер страницы;
поле 2 - обозначение документа;
поле 3 - текст документа;
поле 4 - строка изменений; заполняется в соответствии с требованиями ГОСТ 19.604-78.
Рамку (границы) формата страниц документа допускается не наносить.
2.1.3. Аннотацию размещают на отдельной (пронумерованной) странице с заголовком «АННОТАЦИЯ» и не нумеруют как раздел.
В аннотации указывают издание программы, кратко излагают назначение и содержание документа. Если документ состоит из нескольких частей, в аннотации указывают общее количество частей.
Наименования, включенные в содержание, записывают строчными буквами. Прописными должны печататься заглавные буквы и аббревиатуры.
2.1.3, 2.1.4. (Измененная редакция, Изм. № 1).
2.1.5. Текст каждого документа, при необходимости, разбивается на пункты, а пункты - на подпункты, независимо от того, разделён документ на части, разделы и подразделы или нет.
2.1.6. Структурными элементами текста документа являются разделы, подразделы, пункты, подпункты и перечисления.
Раздел - первая ступень деления, обозначенная номером и снабженная заголовком.
Подраздел - часть раздела, обозначенная номером и имеющая заголовок.
Пункт - часть раздела или подраздела, обозначенная номером. Может иметь заголовок.
Подпункт - часть пункта, обозначенная номером, может иметь заголовок.
Абзац - логически выделенная часть текста, не имеющая номера.
При отсутствии разделов в тексте документа его первым структурным элементом является пункт.
Допускается помещать текст между заголовками раздела и подраздела, между заголовками подраздела и пункта.
Внутри подразделов, пунктов и подпунктов могут быть даны перечисления, которые рекомендуется обозначать арабскими цифрами со скобкой: 1), 2) и т. д. Допускается выделять перечисления простановкой дефиса перед текстом.
Каждый структурный элемент начинается с абзацного отступа.
(Измененная редакция, Изм. № 1).
2.1.7. Заголовки разделов пишут прописными буквами и размещают симметрично относительно правой и левой границ текста.
Заголовки подразделов записывают с абзаца строчными буквами (кроме первой прописной).
Допускается при машинном способе выполнения документа заголовки подразделов и пунктов записывать шрифтом, имеющимся на печатающем устройстве.
Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят.
Если заголовок состоит из двух предложений, их разделяют точкой.
(Измененная редакция, Изм. № 1).
2.1.8. Расстояние между заголовком и последующим текстом, а также между заголовками раздела и подраздела должно быть равно:
при выполнении документа машинописным способом - двум интервалам;
при выполнении рукописным способом - 10 мм;
при выполнении машинным способом - не менее трёх высот шрифта.
Для разделов и подразделов, текст которых записывают на одной странице с текстом предыдущего раздела, расстояние между последней строкой текста и последующим заголовком должно быть равно:
при выполнении документа машинописным способом - трём машинописным интервалам;
при выполнении рукописным способом - не менее 15 мм;
при выполнении машинным способом - не менее четырёх высот шрифта.
Расстояние между основаниями строк заголовка принимают такие же, как в тексте.
При типографском способе издания документов указанные расстояния оформляют по правилам для типографских изданий.
2.1.9. Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой.
Разделы должны иметь порядковый номер (1, 2 и т. д.).
В пределах раздела должна быть сквозная нумерация по всем подразделам, пунктам и подпунктам, входящим в данный раздел.
Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделённые точкой (2.1; 3.1 и т. д.).
При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т.д.).
Пример структуры текста программного документа и нумерации его разделов, подразделов, пунктов и подпунктов приведён в справочном приложении 2.
(Измененная редакция, Изм. № 1).
2.1.10. (Исключен, Изм. № 1)
2.2. Текст документа.
2.2.1. Текст документа должен быть кратким, четким, исключающим возможность неверного толкования.
Термины и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии - общепринятым в научно-технической литературе, и приводиться в перечне терминов.
2.2.2. Допускаются сокращения слов в тексте и надписях под иллюстрациями по ГОСТ 2.316-68. Дополнительные сокращения, принятые в документе и не входящие в ГОСТ 2.316-68, следует приводить в перечне принятых сокращений.
2.2.3. Для выделения отдельных понятий допускается изменять интервалы между словами, а также печатать отдельные слова или части текста шрифтом, отличным от печати основного текста, например:
UNCATLG - указывает, что запись каталога, относящаяся кисходному набору данных, должна быть исключена.ТО = устройство = список - указывает носители данных, на которыеосуществляется...АВС3-91 СИНТАКСИЧЕСКАЯ ОШИБКАПРИЧИНА. Указанный в сообщении...ДЕЙСТВИЯ СИСТЕМЫ. Задание не выполняется...ДЕЙСТВИЯ ПРОГРАММИСТА. Необходимо обеспечить...
2.2.4. Необходимые пояснения к тексту документа могут оформляться сносками.
Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего обреза шрифта, например: «печатающее устройство2)...» или «бумага5)».
Если сноска относится к отдельному слову, знак сноски помещается непосредственно у этого слова, если же к предложению целом, то в конце предложения. Текст сноски располагают в конце страницы и отделяют от основного текста линией длиной 3 см, проведённой в левой части страницы.
2.3. Иллюстрации.
2.3.1. Иллюстрации могут быть расположены в тексте документа и (или) в приложениях.
Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа.
В приложениях иллюстрации нумеруются в пределах каждого приложения в порядке, установленном для основного текста документа.
Иллюстрации могут иметь тематический заголовок и подрисуночный текст, поясняющий содержание иллюстрации.
Тематический заголовок (наименование) помещают над иллюстрацией, подрисуночный текст - под ней. Номер иллюстрации помещают под поясняющими данными.
(Измененная редакция, Изм. № 1).
2.4. Формулы.
2.4.1. Формулы в документе, если их более одной, нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках на уровне формулы.
В пределах всего документа или его частей, в случае деления документа на части, формулы имеют сквозную нумерацию.
При делении документа на части номер части ставится перед порядковым номером формулы и отделяется от последней точкой, например: «в формуле (1.4)».
2.4.2. Значение символов и числовых коэффициентов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле. Первая строка расшифровки должна начинаться со слова «где», без двоеточия после него.
Если в программном документе приведен перечень этих символов и числовых коэффициентов, значения из под формулой допускается не приводить.
(Измененная редакция, Изм. № 1).
2.4.3. Размерность одного и того же параметра в пределах одного документа должна быть постоянной.
2.5.1. В программных документах допускаются ссылки на стандарты (кроме стандартов предприятий), технические условия и другие документы (например, документы органов Государственного надзора, правила и нормы Госстроя СССР). При ссылках на стандарты и технические условия указывают их обозначение.
Ссылаться следует на документ в целом или на его разделы (с указанием обозначения и наименования документа, номера и наименования раздела или приложения). При повторных ссылках на раздел или приложение указывают только номер.
Допускается указывать только обозначение документа и (или) разделов без указания их наименований. Ссылки на отдельные подразделы, пункты и иллюстрации другого документа не допускаются. Допускаются ссылки внутри документа на пункты, иллюстрации и отдельные подразделы.
(Измененная редакция, Изм. № 1).
2.6. Таблицы
2.6.1. Цифровой материал для достижения лучшей наглядности и сравнимости показателей, как правило, следует оформлять в виде таблицы.
2.6.2. Оформление таблиц должно производиться в соответствии с требованиями ГОСТ 1.5-68.
Таблица может иметь заголовок, который следует выполнять строчными буквами. Прописными должны печататься заглавные буквы и аббревиатуры.
(Измененная редакция, Изм. № 1).
2.6.3. Сноски к таблицам располагают непосредственно под таблицей. Например:
Наборы данных, используемые для распечатки
Назначение
Стандартное имя
Используемое устройство
Для информационной распечатки
SSSSSSS1) Печатающее устройство2)
Для распечатки во время выполнения программы
РРРРРРРР Печатающее устройство2)
1) Имя SSSSSSS должно быть задано при настройке операционной системы.
2) Для уменьшения простоев центрального процессора из-за операций ввода-вывода может быть использована магнитная лента.
2.7. Примечания.
2.7.1. В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.
Одно примечание не нумеруется. После слова «Примечание» ставят точку.
Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. После слова «Примечание» ставят двоеточие.
Например:
П р и м е ч а н и е.
П р и м е ч а н и я:1. 2.
2.7.2. Текст примечаний допускается печатать только через один интервал.
2.8. Сокращения.
2.8.1. Сокращения слов в тексте и надписях под иллюстрациями не допускаются, за исключением:
сокращений, установленных в ГОСТ 2.316-68, и общепринятых в русском языке;
сокращений, применяемых для обозначения программ, их частей и режимов работы, в языках управления заданиями, в средствах настройки программы и т.п., в том числе обозначаемых буквами латинского алфавита.
Если в документе принята особая система сокращений слов или наименований, то в нем должен быть приведен перечень принятых сокращений.
(Измененная редакция, Изм. № 1).
2.9. Приложения
2.9.1. Иллюстрированный материал, таблицы или текст вспомогательного характера допускается оформлять в виде приложений.
Приложения оформляют как продолжение данного документа на последующих страницах или выпускают в виде отдельного документа.
2.9.2. Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова «ПРИЛОЖЕНИЕ» и иметь тематический заголовок, который записывают симметрично тексту прописными буквами.
При наличии в документе более одного приложения все приложения нумеруют арабскими цифрами (без знака №), например, ПРИЛОЖЕНИЕ 1, ПРИЛОЖЕНИЕ 2 и т. д.
При выпуске приложения отдельным документом, на титульном листе под наименованием документа следует указывать слово «ПРИЛОЖЕНИЕ», а при наличии нескольких приложений указывают также их порядковые номера.
Приложения, выпущенные в виде отдельного документа, обозначают как часть документа. При необходимости в таком приложении может быть помещено «Содержание».
Допускается объединять несколько приложений в отдельную часть программного документа.
(Измененная редакция, Изм. № 1).
2.9.4. Нумерация страниц документа и приложений, входящих в состав документа, должна быть сквозная, если приложения не выполняются отдельным документом.
Иллюстрации и таблицы в приложениях нумеруют в пределах каждого приложения.
(Измененная редакция, Изм. № 1).
Все приложения должны быть перечислены в листе «Содержание».
3. ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ, СОДЕРЖАЩИМ ТЕКСТ, РАЗБИТЫЙ НА ГРАФЫ.
3.1. Программные документы, содержащие текст, разбитый на графы, при необходимости разделяют на разделы и подразделы, которые не нумеруют. Допускается линии, разграничивающие строки и графы, не наносить.
3.2. Наименования разделов и подразделов записывают в виде заголовков строчными буквами (кроме первой прописной) и подчёркивают.
Расстояние между заголовком и последующим текстом, между текстом и последующим заголовком и между заголовками должны соответствовать указанным в п. 2.1.8.
3.3. Примечания в документе оформляются в порядке, изложенном в п. 2.7.
3.4. В таблицах и формах, имеющих строки, все записи размещают на каждой строке в один ряд.
Записи не должны сливаться с линиями, разграничивающими строки и графы.
Следует оставлять свободные строки между разделами и подразделами, а в документах большого объёма - также внутри разделов и подразделов.
Если в графе документа записан текст в несколько строк, то в последующих графах записи начинают на уровне первой строки. Допускается помещать запись на уровне последней строки, если она занимает одну строку.
(Измененная редакция, Изм. № 1).
ПРИЛОЖЕНИЕ 1
Справочное
ИНФОРМАЦИОННЫЕ ДАННЫЕ О СООТВЕТСТВИИ ГОСТ 19.106-78
СТ СЭВ 2088-80
Разд. 1 ГОСТ 19.106-78 соответствует разд. 1 и разд. 4 (п. 4.1) СТ СЭВ 2088-80.
Разд. 2 ГОСТ 19.106-78 соответствует разд. 4 (пп. 4.4-4.9) СТ СЭВ 2088-80.
(Введено дополнительно, Изм. № 1).
ПРИЛОЖЕНИЕ 2
Справочное
СТРУКТУРА ТЕКСТА ПРОГРАММНОГО ДОКУМЕНТА
ОСНОВНЫЕ НАДПИСИ
United system for program documentation.
Постановлением Государственного комитета СССР по стандартам от 18 декабря 1978 г. № 3351 срок введения установлен
с 01.01 1980 г.
Настоящий стандарт устанавливает формы, размеры, расположение и порядок заполнения основных надписей листа утверждения и титульного листа в программных документах, предусмотренных стандартами ЕСПД, независимо от способов их выполнения.
Стандарт соответствует СТ СЭВ 2088-80 в части оформления листа утверждения и титульного листа (см. справочное приложение 1).
1. ОСНОВНЫЕ ПОЛОЖЕНИЯ
1.1. В состав основных надписей листа утверждения и титульного листа в программных документах входят следующие структурные данные:
наименование министерства (ведомства);
наименование документа;
обозначение документа;
сведения о носителе данных, на котором представляется подлинник;
общее количество листов утверждения, объём документа;
сведения о разработчике;
виза нормоконтролёра;
отметка об учёте и хранении;
сведения об изменении.
2. ОСНОВНЫЕ НАДПИСИ ЛИСТА УТВЕРЖДЕНИЯ (ЛУ)
2.1. Лист утверждения выпускается на каждый программный документ на листах бумаги формата А4 (ГОСТ 2.301-68), независимо от вида документа, который может быть выполнен на любом носителе данных.
2.2. Обозначение листа утверждения состоит из обозначения документа, к которому относится лист утверждения, и через дефис – шифра ЛУ.
Лист утверждения не входит в общее количество листов документа.
2.3. Лист утверждения может включать несколько листов, в этом случае каждый лист нумеруется. На первом листе указывается общее количество листов, входящих в лист утверждения.
Второй и последующие листы утверждения оформляют в соответствии с разд. 1 ГОСТ 19.106-78, при этом в поле «Текст документа» приводят должности и подписи лиц, не уместившихся на первом листе листа утверждения.
2.4. Лист утверждения вносят в спецификацию после утвержденного документа и хранят на предприятии – держателе подлинника документа.
Лист утверждения спецификации также вносят в данную спецификацию.
Копии листа утверждения высылают заказчику и головному предприятию.
По особому разрешению заказчика лист утверждения может быть выслан и в другие организации.
2.5. Лист утверждения заполняют по форме, приведенной на чертеже:
поле 1 - наименование министерства или ведомства, в систему которого входит организация, разработавшая данный документ.
Заполняют по требованию заказчика.
Выше поля 1, в правом верхнем углу, при необходимости ставится специальная отметка (гриф секретности, указание «С предприятия не выносить» и т.п.);
поле 2 - в левой части поля - должности и подписи лиц, согласовавших документ от организации заказчика при необходимости, в правой части поля - должности и подписи лиц, утвердивших документ от организации разработчика.
Согласующие и утверждающие организации, а также конкретные подписи должностных лиц регламентируют министерства и ведомства;
Наименование документа может быть опущено или объединено с наименованием программы;
Вид носителя данных указывают только в случае выполнения документа на носителе данных;
поле 5 - общее количество листов утверждения, например, «Листов 3». Для одного листа поле 5 не заполняют;
поле 6 - в правой части поля - должности и подписи руководителя организации, выпустившей документ, руководителя подразделения, разработавшего документ, руководителя разработки (разработчика), исполнителей разработки документа и нормоконтролёра.
Справа от каждой подписи проставляют инициалы и фамилию лица, подписавшего документ, а ниже подписи - дату подписания.
При большом количестве согласующих подписей их размещают либо в левой части поля 2, либо в левой части поля 6.
Визы других должностных лиц, если они необходимы на документе, размещают на поле для подшивки ЛУ;
поле 9 - строка изменений по ГОСТ 19.604-78;
поле 10 - литера документа.
Пример заполнения ЛУ приведён в справочном приложении 2. Количество подписей в приложении приведено условно.
3. ОСНОВНЫЕ НАДПИСИ ТИТУЛЬНОГО ЛИСТА
3.1. Титульный лист заполняют по форме и правилам, установленным для ЛУ, при этом:
поле 1 - заполняют по требованию заказчика;
поле 2 - не заполняют;
поле 3 - полное наименование программы или программного изделия (прописными буквами), наименование и вид документа.
Наименование документа может быть опущено или объединено с наименованием продукта. Допускается указывать сокращённое наименование программы или программного изделия;
поле 4 - обозначение документа и указание вида носителя данных.
Вид носителя данных указывают только в случае выполнения программного документа на носителе данных;
поле 5 - указывают объём документа;
поле 6- не заполняют;
поле 7 - год издания (утверждения) документа (без указания слова «год» или «г»);
поле 8 - отметка об учёте и хранении по ГОСТ 19.601-78;
поле 9 - строка изменений по ГОСТ 19604-78;
поле 10 - литера документа.
3.2. На титульном листе в левом верхнем углу должна быть надпись:
Утвержден----------------------обозначение ЛУ
Пример заполнения титульного листа приведён в справочном приложении 3.
4. ОСНОВНЫЕ НАДПИСИ В ТЕКСТЕ ДОКУМЕНТА.
ПРИЛОЖЕНИЕ 1
Справочное
ИНФОРМАЦИОННЫЕ ДАННЫЕ О СООТВЕТСТВИИ ГОСТ 19.104-78
СТ СЭВ 2088-80
Разд. 1 и 2 ГОСТ 19.104-78 соответствует разд. 2 СТ СЭВ 2088-80
Разд. 3 ГОСТ 19.104-78 соответствует разд. 3 СТ СЭВ 2088-80
ПРИЛОЖЕНИЕ 2
Справочное
ПРИМЕР ЗАПОЛНЕНИЯ ЛИСТА УТВЕРЖДЕНИЯ
СОГЛАСОВАНО
Руководитель ЦКБ
(подпись) А. А. Петров
УТВЕРЖДАЮ
Начальник управления
(подпись) Н. Н. Сизов
МАШИН ОПЕРАЦИОННАЯ СИСТЕМА
Загрузчик
Руководство программиста
ЛИСТ УТВЕРЖДЕНИЯ
А.В.00001-01 33 01-1-ЛУ
(вид носителя данных)
СОГЛАСОВАНО
Руководитель ВЦ
(подпись) И. И. Павлов
Главный инженер завода
(подпись) А. А. Иванов
Представители
предприятия-разработчика
Главный инженер
НИИавтоматика
(подпись) А. В. Басов
Начальник отдела 12
(подпись) Г. Ф. Сизов
Руководитель разработки
(подпись) Л. А. Соколов
Исполнитель
(подпись) А. М. Пашин
Нормоконтролер
(подпись) Г. В. Громова
ПРИЛОЖЕНИЕ 3
Справочное
ПРИМЕР ЗАПОЛНЕНИЯ ТИТУЛЬНОГО ЛИСТА
УТВЕРЖДЕНО
А.В.00001-01 33 01-1-ЛУ
ЕДИНАЯ СИСТЕМА ЭЛЕКТРОННЫХ ВЫЧИСЛИТЕЛЬНЫХ
МАШИН ОПЕРАЦИОННАЯ СИСТЕМА
Загрузчик
Руководство программиста
А.В.00001-01 33 01-1
(вид носителя данных)
| | | следующая лекция ==>
ЕСПД – относится к комплексным системам общетехнических стандартов ЕСПД представляет собой систему межгосударственных стандартов стран СНГ, действующих на территории РФ, на основе межгосударственного соглашения по стандартизации. Стандарты ЕСПД охватывают ту часть документации, которая создается в процессе разработки программных средств и связанны по большей части с документированием функциональных характеристик программных средств. Стандарты ЕСПД носят рекомендательный характер ЕСПД – это комплекс государственных стандартов, устанавливающих взаимоувязанные правила разработки, оформления и обращения программ и программной документации Стандарты ЕСПД устанавливают требования, регламентирующие разработку, сопровождение изготовление и эксплуатацию программ, что обеспечивает возможность: 1. Унификации программных изделий для взаимного обмена программами и применение ранее разработанных программ в новых разработках 2. Снижение трудоемкости и повышение эффективности разработки, сопровождения, изготовление и эксплуатации программных изделий 3. Автоматизации, изготовление и хранение программной документации Сопровождение программы включает анализ функционирования, развитие и совершенствование программы, а также внесение изменений в нее с целью устранения ошибок Правила и положения, установленные в стандартах ЕСПД распространяются на программы и программную документацию для вычитательных машин, комплексов и систем, независимо от иъ назначения и области применения В состав ЕСПД входят: 1. Основополагающие и организационно-методические стандарты 2. Стандарты, определяющие формы и содержание программных документов, применяемых при обработке данных 3. Стандарты, обеспечивающих автоматизацию разработки программных документов Разработка организационно-методической документации, определяющей и регламентирующей деятельность организаций по разработке, сопровождению и эксплуатации программ должна проводится на основе стандартов ЕСПД Стандарты ЕСПД подразделяются на классификационные группы Стандарты ЕСПД обозначаются следующим образом: ГОСТ 19.001-77 19 – принадлежность стандартов к ЕСПД 0 – Общие положения 77 – год утверждения ГОСТ 19.503-79 - руководство системного программиста. Требования к содержанию и оформлению. Аннотация и содержание обязательно. Руководство системного программиста должно содержать следующие разделы: 1. Общие сведения о программе Назначение и функции программы и сведения о технических и программных средствах, обеспечивающих выполнение данной программы 2. Структура программы Сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами 3. Настройка программы Описание действий по настройке программы на условие конкретного применения (настройка на состав технических средств, выбор функций и другое) 4. Проверка программы Описание способов проверки, позволяющих дать общие заключения о работоспособности программы (контрольные примеры, методы прогона, результаты) 5. Дополнительные возможности Описание дополнительных разделов, функциональных возможностей программы и способов их выбора 6. Сообщение системному программисту Тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и действий, которые необходимо выполнять по этим сообщениям 7. Перечень документов В зависимости от особенности документа допускается объединять отдельные разделы и вводить новые. В обоснованных случаях допускается раздел «дополнительные возможности» не приводить, а в наименованиях разделов – опускать слово программа, или заменять его на наименование программы В приложении к руководству системного программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики…) ГОСТ 19.504-79 - руководство программиста. Требования к содержанию и оформлению. Аннотация и содержание обязательны. Руководство программиста должно содержать следующие разделы: 1. Назначение и условия применения Назначение и функции, условия, необходимые для выполнения (объем RAM, требования к составу и параметрам периферийных устройств, требования к ПО) 2. Характеристики программы Описание основных характеристик и особенности программы (временные характеристики режим работы, средства контроля правильности выполнения и самовосстонавлеваемости программы) 3. Обращение к программе Описание процедур вызова программы (способы передачи управления и параметров данных) 4. В/В данные Описание организации В/В информации и при необходимости ее кодирование 5. Сообщение Тексты сообщений, выдаваемых программисту или оператору, в ходе выполнения программы, описание их содержания и действий, которые необходимо выполнять по этим сообщениям 6. Перечень документов В зависимости от особенности документа допускается объединять отдельные разделы и вводить новые. В приложении к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики…) ГОСТ 19.505-79 - руководство оператора. Требования к содержанию и оформлению. Аннотация и содержание обязательны. Руководство оператора должно содержать следующие разделы: 1. Назначение программы Сведения о назначении и информация, достаточная для понимания функций программы и ее эксплуатации 2. Условия выполнения программы Условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратурных и программный средств) 3. Выполнение программе Последовательность действий оператора, обеспечивающих загрузку, запуск и завершение программы (должно быть приведено описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а так же ответы программы на эти команды 4. Сообщение оператору Тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующих действий оператора (действия оператора в случае сбоя, возможности перезапуска программы…) 5. Перечень документов В зависимости от особенности документа допускается объединять отдельные разделы и вводить новые. Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами и графиками. В приложении к руководству оператора допускается включать различные материалы, которые нецелесообразно включать в разделы руководства |
