Виды программной документации
ДОКУМЕНТИРОВАНИЕ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ, ЕСПД
Любая программа должна снабжаться программной документацией. Документирование программ регламентируется стандартами Единой системы программной документации (ЕСПД) вне зависимости от назначения и области применения.
Единая система программнной документации – комплекс государственных стандартов, устанавливающих взаимоувязанные правила разработки, офомления и обращения программ и программной документации.
Виды программ и программных документов для ЭВМ комплексов и систем независимо от их назначения и области применения установлены ГОСТ 19.101-77 и ГОСТ 19781-90.
ПРОГРАММА – это данные, предназначенные для управления конкретными компонентами системы обработки информации в целях реализации определенного алгоритма
Программы подразделяют на два вида: компонент и комплекс.
(или) комплексов, выполняющих взаимосвязанные функции и применяемая самостоятельно или в составе другого комплекса.
К программным документам относят документы, содержащие сведения, необходимые для:
4) эксплуатации программ.
Виды ПД и их содержание, правила оформления документов и их частей устанавливаются соответствующими стандартами ЕСПД.
Для МАЛЫХ АВТОНОМНЫХ программ в качестве документации используется в основном текст оттранслированной программы на языке программирования. Сопровождение таких программ не их разработчиками практически невозможно.
Для БОЛЬШИХ ПРОЕКТОВ программ необходима полная документация.
Для чего нужна документация?
Документация на ПС решает следующие задачи:
1) формализует методы решения задач, состав используемой и выдаваемой информации;
2) способствует резкому сокращению количества ошибок и тем самым облегчает отладку;
3) позволяет вносить и учитывать изменения в программах;
4) обеспечивает возможность замены первичного разработчика программы другим без повторения ранее выполненной работы;
5) позволяет изучать, эксплуатировать и модернизировать ПО;
6) позволяет использовать разработанные компоненты и комплексы
программ в разных ПС и применять сборочное программирование.
Документацию не очень хочется писать. Но без документации кроме всего прочего:
1) можно занести вирус;
2) режимы работы исследуются вслепую методом проб и ошибок;
3) неизвестно что делать в непредвиденных случаях.
Документация должна разрабатываться с самого начала проектирования ПО и непрерывно уточняться для обеспечения полного соответствия программному изделию.
Виды программной документации:
К такой документации относятся документы, которыми руководствуется пользователь при:
— инсталяции ПС (при установке ПС с соответствующей настройкой на среду применения ПС);
— при применении ПС для решения своих задач и при управлении ПС (например, когда данное ПС взаимодействует с другими системами).
Эти документы частично затрагивают вопросы сопровождения ПС, но не касаются вопросов, связанных с модификацией программ.
В связи с этим следует различать две категории пользователей ПС: ординарных пользователей ПС и администраторов ПС. Ординарный пользователь ПС (end-user) использует ПС для решения своих задач (в своей предметной области). Это может быть инженер, проектирующий техническое устройство, или кассир, продающий железнодорожные билеты с помощью ПС. Он может и не знать многих деталей работы компьютера или принципов программирования. Администратор ПС (system administrator) управляет использованием ПС ординарными пользователями и осуществляет сопровождение ПС, не связанное с модификацией программ. Например, он может регулировать права доступа к ПС между ординарными пользователями, поддерживать связь с поставщиками ПС или выполнять определенные действия, чтобы поддерживать ПС в рабочем состоянии, если оно включено как часть в другую систему.
ТЕХНОЛОГИЧЕСКАЯ документация кроме эксплуатационной документации включает ряд документов, необходимых для развития и сопровождения ПО в течение всего жизненного цикла.
ИССЛЕДОВАТЕЛЬСКАЯ документация предназначена для анализа жизненного цикла ПО. Основная ее задача состоит в фиксировании и обобщении характеристик жизненного цикла ПО.
1) программма работает, но ни кто не знает как она это делает
Программная документация и ее разновидности
Ниже мы рассмотрим понятие программной документации и ее разновидности.
Под программной документацией понимают различные виды документов в печатном и электронном виде, содержащих информацию о разработке, изготовлении, испытаниях, эксплуатации и сопровождении программных изделий.
В России разработку программной документации принято проводить в соответствии с требованиями ЕСПД – единой системы программной документации.
С точки зрения ЕСПД программы разделают на следующие виды (ГОСТ 19.101):
Компонент – программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса
Комплекс – программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса
Также в ГОСТ 19.101 упоминается и такое важное понятие как «программное изделие», в п. 1.3 данного стандарта указано следующее: «документация, разработанная на программу, может использоваться для реализации и передачи программы на носителях данных, а также для изготовления программного изделия». А в соответствии с ГОСТ 19.004 программное изделие – это «Программа на носителе данных, являющаяся продуктом промышленного производства».
Отдельно необходимо сказать несколько слов о разработке технических условий на программу (а если точнее на программное изделие, этот термин мы поясняли немного выше). В том же ГОСТ 19-101 достаточно немного про них написано, а именно «2.7. На этапе разработки и утверждения технического задания определяют необходимость составления технических условий, содержащих требования к изготовлению, контролю и приемке программы. Технические условия разрабатывают на стадии «Рабочий проект».
Т.е. получается, что если в техническом задании нет требований по разработке ТУ на программу, то вроде бы можно и не разрабатывать. Однако довольно часто этот документ все же разрабатывают т.к. он достаточно полезен при изготовлении, контроле, приемке, а также и при сертификации программных изделий, особенно актуальна разработка технических условий на программу при работах в интересах государственного Заказчика (МО РФ и др.). Необходимо упомянуть и следующую особенность – в системе ЕСПД не существует стандарта, предъявляющего требования к разделам и содержанию ТУ на программное изделие. Обычно при разработке ТУ руководствуются требованиями «конструкторского» ГОСТ 2.114, применяя его основные требования, оформление же делают в соответствии с ГОСТ 19-106 (т.е. без рамки как в КД).
Также необходимо упомянуть о том, что в зависимости от способа выполнения и характера применения программные документы подразделяются на подлинник, дубликат и копию (ГОСТ 2.102), предназначенные для разработки, сопровождения и эксплуатации программы.
Виды программных документов
Какие же бывают виды программных документов? В соответствии с ГОСТ 19-101 предусмотрена следующая классификация программных документов:
Вид программного документа
Содержание программного документа
Состав программы и документации на нее
Ведомость держателей подлинников
Перечень предприятий, на которых хранят подлинники программных документов
Запись программы с необходимыми комментариями
Сведения о логической структуре и функционировании программы
Программа и методика испытаний
Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля
Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний
Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений
Сведения для обеспечения функционирования и эксплуатации программы
Отдельно выделяется категория эксплуатационных документов:
Вид эксплуатационного документа
Содержание эксплуатационного документа
Ведомость эксплуатационных документов
Перечень эксплуатационных документов на программу
Основные характеристики программы, комплектность и сведения об эксплуатации программы
Сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств
Руководство системного программиста
Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения
Сведения для эксплуатации программы
Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы
Описание синтаксиса и семантики языка
Руководство по техническому обслуживанию
Сведения для применения тестовых и диагностических программ при обслуживании технических средств
Виды программных документов, разрабатываемых на разных стадиях разработки, приведены в таблице ниже:
Код вида документа
Ведомость держателей подлинников
Ведомость эксплуатационных документов
Руководство системного программиста
Руководство по техническому обслуживанию
Программа и методика испытаний
Что относят к внешней программной документации
Единая система программной документации
Unified system for program documentation. Development stages
Дата введения 1980-01-01
Постановлением Государственного комитета стандартов Совета Министров СССР от 20 мая 1977 г. N 1268 дата введения установлена 01.01.80
ПЕРЕИЗДАНИЕ. Январь 2010 г.
1. Настоящий стандарт устанавливает стадии разработки программ и программной документации для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
2. Стадии разработки, этапы и содержание работ должны соответствовать указанным в таблице.
1. Техническое задание
Обоснование необходимости разработки программы
Сбор исходных материалов.
Выбор и обоснование критериев эффективности и качества разрабатываемой программы.
Обоснование необходимости проведения научно-исследовательских работ
Определение структуры входных и выходных данных.
Предварительный выбор методов решения задач.
Обоснование целесообразности применения ранее разработанных программ.
Определение требований к техническим средствам.
Обоснование принципиальной возможности решения поставленной задачи
Разработка и утверждение технического задания
Определение требований к программе.
Разработка технико-экономического обоснования разработки программы.
Определение стадий, этапов и сроков разработки программы и документации на нее.
Выбор языков программирования.
Определение необходимости проведения научно-исследовательских работ на последующих стадиях.
Согласование и утверждение технического задания
Разработка эскизного проекта
Предварительная разработка структуры входных и выходных данных.
Уточнение методов решения задачи.
Разработка общего описания алгоритма решения задачи.
Разработка технико-экономического обоснования
Утверждение эскизного проекта
Разработка пояснительной записки.
Согласование и утверждение эскизного проекта
3. Технический проект
Разработка технического проекта
Уточнение структуры входных и выходных данных.
Разработка алгоритма решения задачи.
Определение формы представления входных и выходных данных.
Определение семантики и синтаксиса языка.
Разработка структуры программы.
Окончательное определение конфигурации технических средств
Утверждение технического проекта
Разработка плана мероприятий по разработке и внедрению программ.
Разработка пояснительной записки.
Согласование и утверждение технического проекта
Программирование и отладка программы.
Разработка программной документации
Разработка программных документов в соответствии с требованиями ГОСТ 19.101-77.
Разработка, согласование и утверждение программы и методики испытаний.
Проведение предварительных государственных, межведомственных, приемо-сдаточных и других видов испытаний.
Корректировка программы и программной документации по результатам испытаний
Подготовка и передача программы
Подготовка и передача программы и программной документации для сопровождения и (или) изготовления.
Оформление и утверждение акта о передаче программы на сопровождение и (или) изготовление.
Передача программы в фонд алгоритмов и программ
2. Допускается объединять, исключать этапы работ и (или) их содержание, а также вводить другие этапы работ по согласованию с заказчиком.
Электронный текст документа
подготовлен ЗАО «Кодекс» и сверен по:
Программные и эксплуатационные документы
Документация, разработанная на программу, может использоваться для реализации и передачи программы на носителях данных, а также для изготовления программного изделия.
К программным относят документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ, а именно:
1 Спецификация – содержит состав программы и документации на нее. Выполняется на стадии рабочего проекта. Является обязательным документом для комплексов и тех компонентов, которые могут иметь самостоятельное применение[3].
2 Ведомость держателей подлинников (код вида документа – 05) – содержит перечень предприятий, на которых хранят подлинники программных документов. Выполняется на стадии рабочего проекта. Необходимость составления документа на этапе утверждения технического задания (по согласованию)[4].
3 Текст программы (код вида документа – 12) – содержит запись программы с необходимыми комментариями. Выполняется на стадии рабочего проекта. Необходимость – по согласованию[5].
4 Описание программы (код вида документа – 13) – содержит сведения о логической структуре и функционировании программы. Выполняется на стадии рабочего проекта. Необходимость – по согласованию[6].
5 Программа и методика испытаний (код вида документа – 51) – содержит требования, подлежащие проверке при испытаниях программы, а также порядок и методы их контроля. Выполняется на стадии рабочего проекта. Необходимость – по согласованию[7].
6 Техническое задание – содержит назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний. Выполняется на стадии технического задания и является обязательным документом для комплекса. Необходимость составления технических заданий на компоненты определяется по согласованию с заказчиком[8].
7 Пояснительная записка (код вида документа – 81) – содержит схему алгоритма, общее описание алгоритма и /или функционирования программы, а также обоснование принятых технических и технико-экономических решений. Выполняется на стадии эскизного и технического проектов. Необходимость – по согласованию[9].
8 Эксплуатационные документы – содержит сведения для обеспечения функционирования и эксплуатации программы. Выполняются на стадии рабочего проекта. Необходимость – по согласованию для каждого документа отдельно.
К эксплуатационным относятся следующие документы:
1 Ведомость эксплуатационных документов (код вида документа – 20) – содержит перечень эксплуатационных документов на программу[10].
2 Формуляр (код вида документа – 30) – содержит основные характеристики программы, комплектность и сведения об эксплуатации программы[11].
3 Описание применения (код вида документа – 31) – содержит сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств[12].
4 Руководство системного программиста (код вида документа – 32) – содержит сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения[13].
5 Руководство программиста (код вида документа – 33) – содержит сведения для эксплуатации программы[14].
6 Руководство оператора (код вида документа – 34) – содержит сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы[15].
7 Описание языка (код вида документа – 35) – содержит описание синтаксиса и семантики языка[16].
8 Руководство по техническому обслуживанию (код вида документа – 46) – содержит сведения для применения тестовых и диагностических программ при обслуживании технических средств [17, 18, 19].
Помимо оговариваемых стандартом, на программу могут выпускаться и другие программные и эксплуатационные документы, им присваиваются коды от 90 до 99.
Можно объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра). В объединенных документах должны содержаться сведения, которые необходимо включать в каждый объединяемый документ.
Обозначение программ и документов состоит из групп знаков, разделенных точками (после кода страны и кода организации-разработчика), пробелами (после номера редакции документа и кода вида документа), дефисами (после регистрационного номера и номера документа данного вида).
Программа и ее документ – спецификация имеет следующую структуру обозначения, см. рисунок 1.1.
Рисунок 1.1 – Структура обозначения программы и ее документа.
Структура обозначения других программных документов, см. рис. 1.2.
Рисунок 1.2 – Структура обозначения других программных документов
Кода страны–разработчика и код организации-разработчика присваивают в установленном порядке.
Регистрационный номер присваивается в порядке возрастания, начиная с 00001 до 99999, для каждой организации–разработчика.
Номер издания программы или номер редакции. номер документа данного вида, номер части документа присваиваются в порядке возрастания с 01 до 99. (Если документ состоит из одной части, то дефис и порядковый номер части не указывают.)
Номер редакции спецификации и ведомости эксплуатационных документов на программу должны совпадать с номером издания этой же программы[20].
Дата добавления: 2015-09-18 ; просмотров: 3932 ; ЗАКАЗАТЬ НАПИСАНИЕ РАБОТЫ