что такое программная документация
Программная документация и ее разновидности
Ниже мы рассмотрим понятие программной документации и ее разновидности.
Под программной документацией понимают различные виды документов в печатном и электронном виде, содержащих информацию о разработке, изготовлении, испытаниях, эксплуатации и сопровождении программных изделий.
В России разработку программной документации принято проводить в соответствии с требованиями ЕСПД – единой системы программной документации.
С точки зрения ЕСПД программы разделают на следующие виды (ГОСТ 19.101):
Компонент – программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса
Комплекс – программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса
Также в ГОСТ 19.101 упоминается и такое важное понятие как «программное изделие», в п. 1.3 данного стандарта указано следующее: «документация, разработанная на программу, может использоваться для реализации и передачи программы на носителях данных, а также для изготовления программного изделия». А в соответствии с ГОСТ 19.004 программное изделие – это «Программа на носителе данных, являющаяся продуктом промышленного производства».
Отдельно необходимо сказать несколько слов о разработке технических условий на программу (а если точнее на программное изделие, этот термин мы поясняли немного выше). В том же ГОСТ 19-101 достаточно немного про них написано, а именно «2.7. На этапе разработки и утверждения технического задания определяют необходимость составления технических условий, содержащих требования к изготовлению, контролю и приемке программы. Технические условия разрабатывают на стадии «Рабочий проект».
Т.е. получается, что если в техническом задании нет требований по разработке ТУ на программу, то вроде бы можно и не разрабатывать. Однако довольно часто этот документ все же разрабатывают т.к. он достаточно полезен при изготовлении, контроле, приемке, а также и при сертификации программных изделий, особенно актуальна разработка технических условий на программу при работах в интересах государственного Заказчика (МО РФ и др.). Необходимо упомянуть и следующую особенность – в системе ЕСПД не существует стандарта, предъявляющего требования к разделам и содержанию ТУ на программное изделие. Обычно при разработке ТУ руководствуются требованиями «конструкторского» ГОСТ 2.114, применяя его основные требования, оформление же делают в соответствии с ГОСТ 19-106 (т.е. без рамки как в КД).
Также необходимо упомянуть о том, что в зависимости от способа выполнения и характера применения программные документы подразделяются на подлинник, дубликат и копию (ГОСТ 2.102), предназначенные для разработки, сопровождения и эксплуатации программы.
программная документация
Смотреть что такое «программная документация» в других словарях:
Документация на программное обеспечение — Эта статья или раздел нуждается в переработке. Пожалуйста, улучшите статью в соответствии с правилами написания статей … Википедия
ГОСТ Р ИСО 9127-94: Системы обработки информации. Документация пользователя и информация на упаковке для потребительских программных пакетов — Терминология ГОСТ Р ИСО 9127 94: Системы обработки информации. Документация пользователя и информация на упаковке для потребительских программных пакетов оригинал документа: 3.2.4. изготовитель: Организация, которая разрабатывает программный… … Словарь-справочник терминов нормативно-технической документации
РД 52.14.617-2000: Инструкция. Порядок проведения нормоконтроля — Терминология РД 52.14.617 2000: Инструкция. Порядок проведения нормоконтроля: документ зафиксированная на материальном носителе информация с реквизитами, позволяющими ее идентифицировать (ГОСТ Р 51141); Определения термина из разных документов:… … Словарь-справочник терминов нормативно-технической документации
ГОСТ Р ИСО/МЭК 15910-2002: Информационная технология. Процесс создания документации пользователя программного средства — Терминология ГОСТ Р ИСО/МЭК 15910 2002: Информационная технология. Процесс создания документации пользователя программного средства оригинал документа: 4.16 n штрих (en dash): Штрих, имеющий такую же ширину, как и строчная буква «n». Определения… … Словарь-справочник терминов нормативно-технической документации
РЕГИОНАЛЬНЫЙ КОМПОНЕНТ ГОСУДАРСТВЕННОГО СТАНДАРТА ПРОФЕССИОНАЛЬНОГО ОБРАЗОВАНИЯ — компонент стандарта, отражающий национально региональные требования к качеству и содержанию профессионального образования и представляющий собой совокупность нормативных документов, разрабатываемых и утверждаемых на региональном уровне: рабочая… … Профессиональное образование. Словарь
аудитория — 4.3 аудитория (audience): Категория пользователей, предъявляющих к документации одинаковые или аналогичные требования и характеристики (например, в части использования документации, ее назначения, уровня обучения, возможностей и опыта персонала) … Словарь-справочник терминов нормативно-технической документации
Определения — 3.2. Определения ПРОГРАММНОЕ СРЕДСТВО программа, снабженная комплектом программных документов. ПРОГРАММНЫЕ ДОКУМЕНТЫ документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программы. Рекомендуемый… … Словарь-справочник терминов нормативно-технической документации
РД 34.35.129-95: Рекомендации. Порядок разработки и поставки программных изделий к персональным ЭВМ для типовых задач тепловых электростанций — Терминология РД 34.35.129 95: Рекомендации. Порядок разработки и поставки программных изделий к персональным ЭВМ для типовых задач тепловых электростанций: 3.2. Определения ПРОГРАММНОЕ СРЕДСТВО программа, снабженная комплектом программных… … Словарь-справочник терминов нормативно-технической документации
ГОСТ 34.003-90: Информационная технология. Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Термины и определения — Терминология ГОСТ 34.003 90: Информационная технология. Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Термины и определения оригинал документа: 1.1 автоматизированная система; АС: Система, состоящая из персонала и … Словарь-справочник терминов нормативно-технической документации
СТО Газпром 2-2.3-141-2007: Энергохозяйство ОАО «Газпром». Термины и определения — Терминология СТО Газпром 2 2.3 141 2007: Энергохозяйство ОАО «Газпром». Термины и определения: 3.1.31 абонент энергоснабжающей организации : Потребитель электрической энергии (тепла), энергоустановки которого присоединены к сетям… … Словарь-справочник терминов нормативно-технической документации
Что такое программная документация
Единая система программной документации
Unified system for program documentation. General principles
Дата введения 1980-01-01
Постановлением Государственного комитета стандартов Совета Министров СССР от 20 мая 1977 г. N 1268 дата введения установлена 01.01.80
ПЕРЕИЗДАНИЕ. Январь 2010 г.
Настоящий стандарт устанавливает целевое назначение, область распространения, классификацию и правила обозначения стандартов, входящих в комплекс Единой системы программной документации (ЕСПД).
1. НАЗНАЧЕНИЕ ЕСПД
1.2. В стандартах ЕСПД устанавливают требования, регламентирующие разработку, сопровождение, изготовление и эксплуатацию программ, что обеспечивает возможность:
унификации программных изделий для взаимного обмена программами и применения ранее разработанных программ в новых разработках;
снижения трудоемкости и повышения эффективности разработки, сопровождения, изготовления и эксплуатации программных изделий;
автоматизации изготовления и хранения программной документации.
Сопровождение программы включает анализ функционирования, развитие и совершенствование программы, а также внесение изменений в нее с целью устранения ошибок.
2. ОБЛАСТЬ РАСПРОСТРАНЕНИЯ И СОСТАВ ЕСПД
2.1. Правила и положения, установленные в стандартах ЕСПД, распространяются на программы и программную документацию для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
2.2. В состав ЕСПД входят:
основополагающие и организационно-методические стандарты;
стандарты, определяющие формы и содержание программных документов, применяемых при обработке данных;
стандарты, обеспечивающие автоматизацию разработки программных документов.
2.3. Разработка организационно-методической документации, определяющей и регламентирующей деятельность организаций по разработке, сопровождению и эксплуатации программ, должна проводиться на основе стандартов ЕСПД.
3. КЛАССИФИКАЦИЯ И ОБОЗНАЧЕНИЕ СТАНДАРТОВ ЕСПД
3.1. Стандарты ЕСПД подразделяют на группы, приведенные в таблице.
ГОСТ 19.101-77 Единая система программной документации. Виды программ и программных документов
ГОСУДАРСТВЕННЫЙ СТАНДАРТ СОЮЗА ССР
ЕДИНАЯ СИСТЕМА ПРОГРАММНОЙ ДОКУМЕНТАЦИИ
Виды программ и программных документов
ГОСУДАРСТВЕННЫЙ СТАНДАРТ СОЮЗА ССР
ЕДИНАЯ СИСТЕМА ПРОГРАММНОЙ ДОКУМЕНТАЦИИ
Виды программ и программных документов
Unified System for program documentation.
Types of programs and program documents
Постановлением Государственного комитета стандартов Совета Министров СССР от 20 мая 1977 г. № 1268 срок действия установлен
*Периздание (Ноябрь 1987 г.) с Изменением №1, Утвержденным в июне 1981 г. (ИУС 9-81)
Настоящий стандарт устанавливает виды программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
Стандарт полностью соответствует СТ СЭВ 1626-79.
1. ВИДЫ ПРОГРАММ
1.1 Программу (по ГОСТ 19781-83) допускается идентифицировать и применять самостоятельно и (или) в составе других программ.
1.2. Программы подразделяют на виды, приведенные в табл. 1.
Определение
Программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса
Программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса
1.3. Документация, разработанная на программу, может использоваться для реализации и передачи программы на носителях данных, а также для изготовления программного изделия.
1.2, 1.3 (Измененная редакция, Изм. № 1).
2. ВИДЫ ПРОГРАММНЫХ ДОКУМЕНТОВ
2.1. К программным относят документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ.
2.2. Виды программных документов и их содержание приведены в табл. 2.
Вид программного документа
Содержание программного документа
Состав программы и документации на нее
Ведомость держателей подлинников
Перечень предприятий, на которых хранят подлинники программных документов
Запись программы с необходимыми комментариями
Сведения о логической структуре и функционировании программы
Программа и методика испытаний
Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля
Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний
Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений
Сведения для обеспечения функционирования и эксплуатации программы
(Измененная редакция, Изм. № 1).
2.3. Виды эксплуатационных документов и их содержание приведены в табл. 3.
Вид эксплуатационного документа
Содержание эксплуатационного документа
Ведомость эксплуатационных документов
Перечень эксплуатационных документов на программу
Основные характеристики программы, комплектность и сведения об эксплуатации программы
Сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств
Руководство системного программиста
Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения
Сведения для эксплуатации программы
Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы
Описание синтаксиса и семантики языка
Руководство по техническому обслуживанию
Сведения для применения тестовых и диагностических программ при обслуживании технических средств
(Измененная редакция, Изм. № 1).
2.4. В зависимости от способа выполнения и характера применения программные документы подразделяются на подлинник, дубликат и копию ( ГОСТ 2.102-68), предназначенные для разработки, сопровождения и эксплуатации программы.
2.5. Виды программных документов, разрабатываемых на разных стадиях, и их коды приведены в табл. 4.
Код вида документа
Ведомость держателей подлинников
Ведомость эксплуатационных документов
Руководство системного программиста
Руководство по техническому обслуживанию
Программа и методика испытаний
— документ обязательный;
— документ обязательный для компонентов, имеющих самостоятельное применение;
2.4, 2.5 (Измененная редакция, Изм. № 1).
2.6. Допускается объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра). Необходимость объединения этих документов указывается в техническом задании. Объединенному документу присваивают наименование и обозначение одного из объединяемых документов.
В объединенных документах должны быть приведены сведения, которые необходимо включать в каждый объединяемый документ.
2.7. На этапе разработки и утверждения технического задания определяют необходимость составления технических условий, содержащих требования к изготовлению, контролю и приемки программы.
Технические условия разрабатывают на стадии «Рабочий проект».
2.8. Необходимость составления технического задания на компоненты, не предназначенные для самостоятельного применения, и комплексы, входящие в другие комплексы, определяются по согласованию с заказчиком.
Большая Энциклопедия Нефти и Газа
Программная документация
Программная документация столь же важна, как и документация по аппаратным средствам. Проектирование и реализацию программы выполняют несколько людей и документирование облегчает взаимодействие между ними в процессе проектирования. После завершения начального этапа проекта документацию нужно привести к форме, понятной даже людям, не принимающим участия в проекте. По мере завершения работы, а иногда и после ее завершения, начинается длительный процесс проверки и исправлений, называемый отладкой. Когда система заработает, могут возникнуть ошибки из-за дефектов хранения и передачи программ, а также более тонкие ошибки, не выявленные на этапе отладки. Процесс выявления ошибок такого типа и их исправления, а также модификации программ из-за изменений в аппаратных средствах называется сопровождением программы. Так как окончательную отладку и сопровождение выполняют люди, которые не составляли программу, очень важно, чтобы программа имела полную документацию. [1]
Программная документация АСУТП должна содержать все сведения, необходимые для понимания функционирования всех программ СПО АСУТП и ПО системы в целом, внесения изменений в программы и развития ПО АСУТП и отдельных программ. [3]
Программная документация рабочего проекта включает руководство программисту, руководство оператору, саму эксплуатационную программу ( ее текст), описание контрольного примера. [4]
В программную документацию рабочего проекта входят: руководство программиста; руководство оператора; эксплуатационная программа или текст программы; описание контрольного примера. [8]
Неполная или нечетко изложенная программная документация является большим препятствием на пути широкого внедрения программных средств. [9]
Единая система программной документации представляет собой комплекс взаимоувязанных государственных стандартов, устанавливающих общие положения, виды программ и программных документов, правила разработки, оформления, обращения программ и программной документации. ЕСПД распространяется на документацию всех типов программ независимо от назначения, области их использования. [10]
При составлении программной документации используются принципы стандартизации и унификации. Согласно ГОСТ 19.101.77 программная документация должна состоять из спецификаций, технического задания и технических условий, текстов и описаний программ, пояснительной записки, общего описания, ведомости эксплуатационных документов и руководртв для системного и прикладного программиста, а также оператора. Опыт эксплуатации САПР показывает, что сюда целесообразно включить также специальное руководство для инженера-проектировщика, где кратко излагается схема и правила его действий в ПП. [11]
При составлении программной документации используются принципы стандартизации и унификации. Согласно ГОСТ 19.101.77 программная документация должна состоять из спецификаций, технического задания и технических условий, текстов и описаний программ, пояснительной записки, общего описания, ведомости эксплуатационных документов и руководств для системного и прикладного программиста, а также оператора. Опыт эксплуатации САПР показывает, что сюда целесообразно включить также специальное руководство для инженера-проектировщика, где кратко излагается схема и правила его действий в ПП. [12]
Изменения в программную документацию разрешается вносить только на основании специальных извещений, согласованных и утвержденных в установленном порядке. Изменения в программные изделия вносятся на основании корректировки документации. [13]
Программы и программную документацию в ПЗ выполняют по стандартам БСПД ( гл. [14]