Программная документация и ее разновидности
Ниже мы рассмотрим понятие программной документации и ее разновидности.
Под программной документацией понимают различные виды документов в печатном и электронном виде, содержащих информацию о разработке, изготовлении, испытаниях, эксплуатации и сопровождении программных изделий.
В России разработку программной документации принято проводить в соответствии с требованиями ЕСПД – единой системы программной документации.
С точки зрения ЕСПД программы разделают на следующие виды (ГОСТ 19.101):
Компонент – программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса
Комплекс – программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса
Также в ГОСТ 19.101 упоминается и такое важное понятие как «программное изделие», в п. 1.3 данного стандарта указано следующее: «документация, разработанная на программу, может использоваться для реализации и передачи программы на носителях данных, а также для изготовления программного изделия». А в соответствии с ГОСТ 19.004 программное изделие – это «Программа на носителе данных, являющаяся продуктом промышленного производства».
Отдельно необходимо сказать несколько слов о разработке технических условий на программу (а если точнее на программное изделие, этот термин мы поясняли немного выше). В том же ГОСТ 19-101 достаточно немного про них написано, а именно «2.7. На этапе разработки и утверждения технического задания определяют необходимость составления технических условий, содержащих требования к изготовлению, контролю и приемке программы. Технические условия разрабатывают на стадии «Рабочий проект».
Т.е. получается, что если в техническом задании нет требований по разработке ТУ на программу, то вроде бы можно и не разрабатывать. Однако довольно часто этот документ все же разрабатывают т.к. он достаточно полезен при изготовлении, контроле, приемке, а также и при сертификации программных изделий, особенно актуальна разработка технических условий на программу при работах в интересах государственного Заказчика (МО РФ и др.). Необходимо упомянуть и следующую особенность – в системе ЕСПД не существует стандарта, предъявляющего требования к разделам и содержанию ТУ на программное изделие. Обычно при разработке ТУ руководствуются требованиями «конструкторского» ГОСТ 2.114, применяя его основные требования, оформление же делают в соответствии с ГОСТ 19-106 (т.е. без рамки как в КД).
Также необходимо упомянуть о том, что в зависимости от способа выполнения и характера применения программные документы подразделяются на подлинник, дубликат и копию (ГОСТ 2.102), предназначенные для разработки, сопровождения и эксплуатации программы.
Программный документ
6. Программный документ
Документ, содержащий в зависимости от назначения данные, необходимые для разработки, производства, эксплуатации и сопровождения программы или программного средства.
Примечание. Программные документы и их части могут выполняться любым способом на любом материале, вводиться в ЭВМ и передаваться по каналам связи
Смотри также родственные термины:
Программный документ Программное обеспечение
Полезное
Смотреть что такое «Программный документ» в других словарях:
Программный документ — документ, содержащий сведения, необходимые для разработки, изготовления, эксплуатации и сопровождения программного изделия. По английски: Program document См. также: Спецификации программных систем Финансовый словарь Финам … Финансовый словарь
программный документ — Документ, содержащий в зависимости от назначения данные, необходимые для разработки, производства, эксплуатации и сопровождения программы или программного средства. Примечание Программные документы и их части могут выполняться любым способом на… … Справочник технического переводчика
программный документ — сущ., кол во синонимов: 2 • платформа (30) • программа (114) Словарь синонимов ASIS. В.Н. Тришин. 2013 … Словарь синонимов
Программный документ Программное обеспечение — По ГОСТ 18.004 80 По ГОСТ 19781 83 Источник … Словарь-справочник терминов нормативно-технической документации
Эксплуатационный программный документ — программный документ, содержащий сведения, необходимые для обеспечения функционирования и эксплуатации программного изделия. По английски: Exploitative document Синонимы: Эксплуатационный документ См. также: Программные изделия Финансовый словарь … Финансовый словарь
Эксплуатационный программный документ — Программный документ, содержащий сведения, необходимые для обеспечения функционирования и эксплуатации программного изделия Источник: РД 34.35.414 91: Правила организации пусконаладочных работ по АСУ ТП на тепловых электростанциях … Словарь-справочник терминов нормативно-технической документации
«Манифест Коммунистической партии» — великий программный документ научного коммунизма — «Манифест Коммунистической партии» был первым программным документом научного коммунизма и первой программой международной коммунистической организации. В нем впервые получили систематическое и цельное изложение все составные части великого… … Всемирная история. Энциклопедия
ПРОГРАММНЫЙ — ПРОГРАММНЫЙ, программная, программное (книжн.). 1. прил. к программа. Программный исток. Обсуждение программных вопросов на партийном съезде. 2. Излагающий, устанавливающий программу. Что делать Ленина программный документ большевизма.… … Толковый словарь Ушакова
программный — ая, ое. programme m. 1. Отн. к программе. Программное задание. БАС 1. Борьба Ленина с оппортунистическими элементами на съезде по программным и организационным вопросам положила водораздел между революционной частью РСДРП большевиками и… … Исторический словарь галлицизмов русского языка
программный — см. программа (кроме 1 зн.); ая, ое Програ/ммный документ сессии. Програ/ммный центр радиовещания. Станки с программным управлением. П ая музыка, симфония (созданная на определённый сюжет, тему) Програ/ммный продукт (программа, предназначенная… … Словарь многих выражений
Программный документ
Смотреть что такое «Программный документ» в других словарях:
Программный документ — По ГОСТ 19781 Источник: ГОСТ 28195 89: Оценка качества программных средств. Общие положения ори … Словарь-справочник терминов нормативно-технической документации
программный документ — Документ, содержащий в зависимости от назначения данные, необходимые для разработки, производства, эксплуатации и сопровождения программы или программного средства. Примечание Программные документы и их части могут выполняться любым способом на… … Справочник технического переводчика
программный документ — сущ., кол во синонимов: 2 • платформа (30) • программа (114) Словарь синонимов ASIS. В.Н. Тришин. 2013 … Словарь синонимов
Программный документ Программное обеспечение — По ГОСТ 18.004 80 По ГОСТ 19781 83 Источник … Словарь-справочник терминов нормативно-технической документации
Эксплуатационный программный документ — программный документ, содержащий сведения, необходимые для обеспечения функционирования и эксплуатации программного изделия. По английски: Exploitative document Синонимы: Эксплуатационный документ См. также: Программные изделия Финансовый словарь … Финансовый словарь
Эксплуатационный программный документ — Программный документ, содержащий сведения, необходимые для обеспечения функционирования и эксплуатации программного изделия Источник: РД 34.35.414 91: Правила организации пусконаладочных работ по АСУ ТП на тепловых электростанциях … Словарь-справочник терминов нормативно-технической документации
«Манифест Коммунистической партии» — великий программный документ научного коммунизма — «Манифест Коммунистической партии» был первым программным документом научного коммунизма и первой программой международной коммунистической организации. В нем впервые получили систематическое и цельное изложение все составные части великого… … Всемирная история. Энциклопедия
ПРОГРАММНЫЙ — ПРОГРАММНЫЙ, программная, программное (книжн.). 1. прил. к программа. Программный исток. Обсуждение программных вопросов на партийном съезде. 2. Излагающий, устанавливающий программу. Что делать Ленина программный документ большевизма.… … Толковый словарь Ушакова
программный — ая, ое. programme m. 1. Отн. к программе. Программное задание. БАС 1. Борьба Ленина с оппортунистическими элементами на съезде по программным и организационным вопросам положила водораздел между революционной частью РСДРП большевиками и… … Исторический словарь галлицизмов русского языка
программный — см. программа (кроме 1 зн.); ая, ое Програ/ммный документ сессии. Програ/ммный центр радиовещания. Станки с программным управлением. П ая музыка, симфония (созданная на определённый сюжет, тему) Програ/ммный продукт (программа, предназначенная… … Словарь многих выражений
Опыт применения ЕСПД
Введение
Основная задача этого текста — рассказать, что такое Единая система программной документации (ЕСПД) и как эти стандарты применять на практике. Начну с рассказа о том, какие бывают стандарты, и закончу опытом применения каждого из ЕСПДшных стандартов в отдельности.
В свое время, когда я только начинал работать программистом, часто приходилось слышать “напиши, пожалуйста, документацию к своей программе”. Я честно все описывал, отдавал начальнику, после чего начинался сеанс черной магии. Начальник через некоторое время меня вызывал и начинал мычать нечленораздельные звуки, мять распечатку моего “самого лучшего” текста в руках, бегая глазами. Общий смысл его мычания заключался в том, что получилось “не то”, “не так”, и “посмотри, как делают другие”. Так как никакого другого ответа из него вытянуть было невозможно, я шел за примерами документов к “другим”. Как правило, это были веселые ребята, смысл речей которых заключался в том, что “вот примеры”, “вообще то по ГОСТу” и “это все никому не нужно”. Так я узнал впервые, что программист может соприкоснуться со страшными ГОСТами.
Поразительно, что среди многих десятков моих коллег, очень неглупых программистов, не было никого, кто бы относился к ГОСТам по другому. Даже те несколько человек, которые их знали и, вроде как, даже умели оформлять документы, относились к ним презрительно-формально. Ситуация, когда даже люди, ответственные за управление разработкой не понимают, зачем нужны ГОСТы и как их применят, встречается на многих предприятиях, сплошь и рядом. Да, были и компании, в которых понимали, чем “Описание программы” отличается от “Описания применения”, но таких было явное меньшинство. В интернете вообще господствует точка зрения, что ГОСТы для программистов — это явный рудимент, и нужны только если “нагибают” под них. Эскизный проект считают “сравнительно честным способом отъемы лишних дензнаков у заказчика”. Вникнуть и разобраться пришлось относительно недавно — в процессе разработки системы управления требованиями, заточенной под отечественную специфику. Документацию которая, разумеется, должна генерировать “по ГОСТу”.
Здесь я хочу сосредоточиться только на одной теме, с которой приходиться иметь дело программисту в отечественных предприятиях, особенно в НИИ — на наборе стандартов ЕСПД. Не считаю себя большим знатоком ЕСПД — есть люди, которые десятки лет по нему работают, и наверняка меня поправят. Статья скорее пытается набросать контуры «дорожной карты» для тех, кто только входит в курс дела.
Стандарты
Системы обозначений на каждом уровне и в каждой организации свои, для каждого случая придется разбираться отдельно. Чтобы быстро понять, “чей” стандарт перед глазами, можно использовать шпаргалку.
Итак: стандарты бывают международные, межгосударственные(региональные) и национальные. ГОСТ, как мы выяснили, это региональный стандарт. ГОСТы имеют достаточно запутанную, на мой взгляд, систему обозначений. Полностью она изложена в ГОСТ Р 1.5-2004, я приведу минимум, что бы в ней ориентироваться. Во первых, надо различать обозначение ГОСТа и его классификацию. Обозначение — это, грубо говоря, уникальный идентификатор стандарта. Код по классификатору — это вспомогательный код, помогающий найти стандарт или определить, к какой области знаний он относиться. Классификаторов может быть много, в основном используются два: КГС (классификатор государственных стандартов) и его наследник ОКС (общероссийский классификатор стандартов). Например: “ГОСТ Р 50628—2000“ — это обозначение стандарта.По обозначению понятно только то, что он принят в 2000 году. Он имеет код по ОКС “33.100;35.160”: т.е. “33” — раздел “Телекоммуникации, аудио, видео”, “100” — подраздел “электромагнитная совместимость”. Однако он также входит в ветвь классификатора 35.160. “35” — “Информационные технологии. Машины конторские”, “160” — “Микропроцессорные системы. ”. А по КГС он имеет код “Э02”, что означает “Э” — “Электронная техника, радиоэлектроника и связь”, “0” — “Общие правила и нормы по электронной технике, радиоэлектронике и связи”, и т.д.
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. Общие требования к программным документам, выполненным печатным способом
В следующих частях планирую уже добраться до конца списка стандартов ЕСПД.
Программный документ Программное обеспечение
Программный документ Программное обеспечение
Смотреть что такое «Программный документ Программное обеспечение» в других словарях:
Программный документ — По ГОСТ 19781 Источник: ГОСТ 28195 89: Оценка качества программных средств. Общие положения ори … Словарь-справочник терминов нормативно-технической документации
Программное обеспечение — Запрос «Software» перенаправляется сюда; см. также другие значения … Википедия
Документация на программное обеспечение — Эта статья или раздел нуждается в переработке. Пожалуйста, улучшите статью в соответствии с правилами написания статей … Википедия
Эксплуатационный программный документ — Программный документ, содержащий сведения, необходимые для обеспечения функционирования и эксплуатации программного изделия Источник: РД 34.35.414 91: Правила организации пусконаладочных работ по АСУ ТП на тепловых электростанциях … Словарь-справочник терминов нормативно-технической документации
ГОСТ Р 54593-2011: Информационные технологии. Свободное программное обеспечение. Общие положения — Терминология ГОСТ Р 54593 2011: Информационные технологии. Свободное программное обеспечение. Общие положения оригинал документа: 3.1 базовый стандарт: Национальный стандарт Российской Федерации, международный стандарт, международный документ по… … Словарь-справочник терминов нормативно-технической документации
ГОСТ 19781-90: Обеспечение систем обработки информации программное. Термины и определения — Терминология ГОСТ 19781 90: Обеспечение систем обработки информации программное. Термины и определения оригинал документа: 9. Абсолютная программа Non relocatable program Программа на машинном языке, выполнение которой зависит от ее… … Словарь-справочник терминов нормативно-технической документации
Pyramid (программный каркас) — Pyramid Тип Программный каркас веб приложений Разработчик … Википедия
ОСТ 1 00366-86: Машины бортовые цифровые вычислительные. Требования к документам на программы специального программного обеспечения — Терминология ОСТ 1 00366 86: Машины бортовые цифровые вычислительные. Требования к документам на программы специального программного обеспечения: Программный документ Программное обеспечение По ГОСТ 18.004 80 По ГОСТ 19781 83 Определения термина… … Словарь-справочник терминов нормативно-технической документации
ГОСТ 28195-89: Оценка качества программных средств. Общие положения — Терминология ГОСТ 28195 89: Оценка качества программных средств. Общие положения оригинал документа: Базовый показатель качества Реально достижимая совокупность значений показателей качества ПС для уравнения Определения термина из разных… … Словарь-справочник терминов нормативно-технической документации
Р 50.1.048-2004: Информационно-телекоммуникационные игровые системы. Термины и определения — Терминология Р 50.1.048 2004: Информационно телекоммуникационные игровые системы. Термины и определения: 2.3.25 адаптивное сопровождение: Изменение программного продукта после поставки, обеспечивающее его работоспособное состояние в измененных… … Словарь-справочник терминов нормативно-технической документации