Главная страница
Навигация по странице:

  • 2. Общая характеристика состояния

  • ISO/IEC 12207: 1995-08-01

  • 2.1. Краткое представление стандартов ЕСПД

  • Kод группы Наименование группы

  • Перечень документов ЕСПД

  • Виды программ Вид программы

  • Виды программных документов Вид программного документа

  • Виды эксплуатационных документов Вид эксплуатационного документа

  • Код вида документа Вид документа Стадии разработки

  • ГОСТ 19.102-77. ЕСПД. Стадии разработки.

  • Стадии разработки, этапы и содержание работ

  • ГОСТ 19.103-77 ЕСПД. Обозначение программ и программных документов

  • ГОСТ 19.105-78 ЕСПД. Общие требования к программным документам

  • ГОСТ 19.106-78 ЕСПД. Требования к программным документам, выполненным печатным способом

  • ЕСПД. 1. Основные вопросы при разработке программных средств


    Скачать 45.58 Kb.
    Название1. Основные вопросы при разработке программных средств
    Дата15.01.2023
    Размер45.58 Kb.
    Формат файлаdocx
    Имя файлаLektsia_Podgotovka_dokumentatsii_na_programmnye_sredstva.docx
    ТипДокументы
    #887724
    страница1 из 2
      1   2

    1. Основные вопросы при разработке программных средств

    Когда программист-разработчик получает в той или иной форме задание на программирование, перед ним, перед руководителем проекта и перед всей проектной группой встают вопросы:

    • что должно быть сделано, кроме собственно программы?

    • что и как должно быть оформлено в виде документации?

    • что передавать пользователям, а что ? службе сопровождения?

    • как управлять всем этим процессом?

    • что должно входить в само задание на программирование?

    Кроме упомянутых вопросов есть и другие.

    На эти и массу других вопросов когда-то отвечали государственные стандарты на программную документацию ? комплекс стандартов 19-й серии ГОСТ ЕСПД. Но уже тогда у программистов была масса претензий к этим стандартам. Что-то требовалось дублировать в документации много раз (как, казалось - неоправданно), а многое не было предусмотрено, как, например, отражение специфики документирования программ, работающих с интегрированной базой данных.

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

    2. Общая характеристика состояния

    Основу отечественной нормативной базы в области документирования ПС составляет комплекс стандартов Единой системы программной документации (ЕСПД). Основная и большая часть комплекса ЕСПД была разработана в 70-е и 80-е годы. Сейчас этот комплекс представляет собой систему межгосударственных стандартов стран СНГ (ГОСТ), действующих на территории Российской Федерации на основе межгосударственного соглашения по стандартизации.

    Стандарты ЕСПД в основном охватывают ту часть документации, которая создается в процессе разработки ПС, и связаны, по большей части, с документированием функциональных характеристик ПС. Следует отметить, что стандарты ЕСПД (ГОСТ 19) носят рекомендательный характер. Впрочем, это относится и ко всем другим стандартам в области ПС (ГОСТ 34, Международному стандарту ISO/IEC, и др.). Дело в том, что в соответствии с Законом РФ "О стандартизации" эти стандарты становятся обязательными на контрактной основе - то есть при ссылке на них в договоре на разработку (поставку) ПС.

    Говоря о состоянии ЕСПД в целом, можно констатировать, что большая часть стандартов ЕСПД морально устарела.

    К числу основных недостатков ЕСПД можно отнести:

    • ориентацию на единственную, "каскадную" модель жизненного цикла (ЖЦ) ПС;

    • отсутствие четких рекомендаций по документированию характеристик качества ПС;

    • отсутствие системной увязки с другими действующими отечественными системами стандартов по ЖЦ и документированию продукции в целом, например, ЕСКД;

    • нечетко выраженный подход к документированию ПС как товарной продукции;

    • отсутствие рекомендаций по самодокументированию ПС, например, в виде экранных меню и средств оперативной помощи пользователю ("хелпов");

    • отсутствие рекомендаций по составу, содержанию и оформлению перспективных документов на ПС, согласованных с рекомендациями международных и региональных стандартов.

    Итак, ЕСПД нуждается в полном пересмотре на основе стандарта ИСО/МЭК 12207-95 на процессы жизненного цикла ПС об этом стандарте далее будет сказано подробнее).

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

    Международный стандарт ISO/IEC 12207: 1995-08-01 на организацию ЖЦ продуктов программного обеспечения (ПО) - казалось бы весьма неконкретный, но вполне новый и отчасти "модный" стандарт.

    Стандарты комплекса ГОСТ 34 на создание и развитие автоматизированных систем (АС) - обобщенные, но воспринимаемые как весьма жесткие по структуре ЖЦ и проектной документации. Но эти стандарты многими считаются бюрократическими до вредности и консервативными до устарелости. Насколько это так, а насколько ГОСТ 34 остается работающим с пользой - полезно разобраться.

    В своей статье Е.З.Зиндер подробно останавливается на методике Oracle CDM (Custom Development Method) по разработке прикладных информационных систем под заказ - конкретный материал, детализированный до уровня заготовок проектных документов, рассчитанных на прямое использование в проектах АС с опорой на инструментарий Oracle.

    2.1. Краткое представление стандартов ЕСПД

    Тем не менее, до пересмотра всего комплекса, многие стандарты ЕСПД могут с пользой применяться в практике документирования ПС. Эта позиция основана на следующем:

    • стандарты ЕСПД вносят элемент упорядочения в процесс документирования ПС;

    • предусмотренный стандартами ЕСПД состав программных документов вовсе не такой "жесткий", как некоторым кажется: стандарты позволяют вносить в комплект документации на ПС дополнительные виды

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

    При этом стиль применения стандартов может соответствовать современному общему стилю адаптации стандартов к специфике проекта: заказчик и руководитель проекта выбирают уместное в проекте подмножество стандартов и ПД, дополняют выбранные ПД нужными разделами и исключают ненужные, привязывают создание этих документов к той схеме ЖЦ, которая используется в проекте.

    Стандарты ЕСПД (как и другие ГОСТы) подразделяют на группы, приведTнные в таблице:

    Kод группы 

    Наименование группы 

    0

    Общие положения

    1

    Основополагающие стандарты

    2

    Правила выполнения документации разработки

    3

    Правила выполнения документации изготовления

    4

    Правила выполнения документации сопровождения

    5

    Правила выполнения эксплуатационной документации

    6

    Правила обращения программной документации

    7

    Резервные группы

    8

    9

    Прочие стандарты

    Обозначение стандарта ЕСПД строят по классификационному признаку:

    Обозначение стандарта ЕСПД должно состоять из:

    • числа 19 (присвоенных классу стандартов ЕСПД);

    • одной цифры (после точки), обозначающей код классификационной группы стандартов, указанной таблице;

    • двузначного числа (после тире), указывающего год регистрации стандарта.

    Перечень документов ЕСПД

    1. ГОСТ 19.001-77 ЕСПД. Общие положения.

    2. ГОСТ 19.101-77 ЕСПД. Виды программ и программных документов.

    3. ГОСТ 19.102-77 ЕСПД. Стадии разработки.

    4. ГОСТ 19.103-77 ЕСПД. Обозначение программ и программных документов.

    5. ГОСТ 19.104-78 ЕСПД. Основные надписи.

    6. ГОСТ 19.105-78 ЕСПД. Общие требования к программным документам.

    7. ГОСТ 19.106-78 ЕСПД. Требования к программным документам, выполненным печатным способом.

    8. ГОСТ 19.201-78 ЕСПД. Техническое задание. Требования к содержанию и оформлению.

    9. ГОСТ 19.202-78 ЕСПД. Спецификация. Требования к содержанию и оформлению.

    10. ГОСТ 19.301-79 ЕСПД. Порядок и методика испытаний.

    11. ГОСТ 19.401-78 ЕСПД. Текст программы. Требования к содержанию и оформлению.

    12. ГОСТ 19.402-78 ЕСПД. Описание программы.

    13. ГОСТ 19.404-79 ЕСПД. Пояснительная записка. Требования к содержанию и оформлению.

    14. ГОСТ 19.501-78 ЕСПД. Формуляр. Требования к содержанию и оформлению.

    15. ГОСТ 19.502-78 ЕСПД. Описание применения. Требования к содержанию и оформлению.

    16. ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению.

    17. ГОСТ 19.504-79 ЕСПД. Руководство программиста.

    18. ГОСТ 19.505-79 ЕСПД. Руководство оператора.

    19. ГОСТ 19.506-79 ЕСПД. Описание языка.

    20. ГОСТ 19.508-79 ЕСПД. Руководство по техническому обслуживанию. Требования к содержанию и оформлению.

    21. ГОСТ 19.604-78 ЕСПД. Правила внесения изменений в программные документы, выполняемые печатным способом.

    22. ГОСТ 19.701-90 ЕСПД. Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения.

    23. ГОСТ 19.781-90. Обеспечение систем обработки информации программное.

    Термины и определения

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

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

    ГОСТ (СТ СЭВ) 19.201-78 (1626-79). ЕСПД. Техническое задание. Требование к содержанию и оформлению. (Переиздан в ноябре 1987г с изм.1).

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

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

    • введение;

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

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

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

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

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

    • стадии и этапы разработки;

    • порядок контроля и приемки;

    • в техническое задание допускается включать приложения.

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

    Следующий стандарт
    ГОСТ (СТ СЭВ) 19.101-77 (1626-79). ЕСПД. Виды программ и программных документов (Переиздан в ноябре 1987г с изм.1).
    Устанавливает виды программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения.

    Виды программ

    Вид программы 

    Определение 

    Компонент

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

    Комплекс

    Программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса

    Виды программных документов

    Вид программного документа 

    Содержание программного документа  

    Спецификация

    Состав программы и документации на нее

    Ведомость держателей подлинников

    Перечень предприятий, на которых хранят подлинники программных документов

    Текст программы

    Запись программы с необходимыми комментариями

    Описание программы

    Сведения о логической структуре и функционировании программы

    Программа и методика испытаний

    Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля

    Техническое задание

    Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний

    Пояснительная записка

    Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений

    Эксплуатационные документы

    Сведения для обеспечения функционирования и эксплуатации программы

    Виды эксплуатационных документов

    Вид эксплуатационного документа 

    Содержание эксплуатационного документа 

    Ведомость эксплуатационных документов

    Перечень эксплуатационных документов на программу

    Формуляр

    Основные характеристики программы, комплектность и сведения об эксплуатации программы

    Описание применения

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

    Руководство системного программиста

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

    Руководство программиста

    Сведения для эксплуатации программы

    Руководство оператора

    Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы

    Описание языка

    Описание синтаксиса и семантики языка

    Руководство по техническому обслуживанию

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

    В зависимости от способа выполнения и характера применения программные документы подразделяются на подлинник, дубликат и копию (ГОСТ 2.102-68), предназначенные для разработки, сопровождения и эксплуатации программы.

    Виды программных документов, разрабатываемых на разных стадиях, и их коды

    Код вида документа 

    Вид документа 

    Стадии разработки 

    Эскизный проект 

    Технический проект 

    Рабочий проект 

    компонент 

    комплекс 

    -

    Спецификация

    -

    -

    !

    +

    05

    Ведомость держателей подлинников

    -

    -

    -

    ?

    12

    Текст программы

    -

    -

    +

    ?

    13

    Описание программы

    -

    -

    ?

    ?

    20

    Ведомость эксплуатационных документов

    -

    -

    ?

    ?

    30

    Формуляр

    -

    -

    ?

    ?

    31

    Описание применения

    -

    -

    ?

    ?

    32

    Руководство системного программиста

    -

    -

    ?

    ?

    33

    Руководство программиста

    -

    -

    ?

    ?

    34

    Руководство оператора

    -

    -

    ?

    ?

    35

    Описание языка

    -

    -

    ?

    ?

    46

    Руководство по техническому обслуживанию

    -

    -

    ?

    ?

    51

    Программа и методика испытаний

    -

    -

    ?

    ?

    81

    Пояснительная записка

    ?

    ?

    -

    -

    90-99

    Прочие документы

    ?

    ?

    ?

    ?




    Условные обозначения:  

    +

    - документ обязательный;  

    !

    - документ обязательный для компонентов, имеющих самостоятельное применение;  

    ?

    - необходимость составления документа определяется на этапе разработки и утверждения технического задания;  

    -

    - документ не составляют.  

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

    ГОСТ 19.102-77. ЕСПД. Стадии разработки.

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

    Стадии разработки, этапы и содержание работ

    Стадии разработки 

    Этапы работ 

    Содержание работ 

    Техническое задание

    Обоснование необходимости разработки программы

    Постановка задачи.
    Сбор исходных материалов.
    Выбор и обоснование критериев эффективности и качества разрабатываемой программы.
    Обоснование необходимости проведения научно-исследовательских работ.

    Научно-исследовательские работы

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

    Разработка и утверждение технического задания

    Определение требований к программе.
    Разработка технико-экономического обоснования разработки программы.
    Определение стадий, этапов и сроков разработки программы и документации на нее.
    Выбор языков программирования.
    Определение необходимости проведения научно-исследовательских работ на последующих стадиях.
    Согласование и утверждение технического задания.

    Эскизный проект

    Разработка эскизного проекта

    Предварительная разработка структуры входных и выходных данных.
    Уточнение методов решения задачи.
    Разработка общего описания алгоритма решения задачи.
    Разработка технико-экономического обоснования.

    Утверждение эскизного проекта

    Разработка пояснительной записки.
    Согласование и утверждение эскизного проекта

    Технический проект

    Разработка технического проекта

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

    Утверждение технического проекта

    Разработка плана мероприятий по разработке и внедрению программ.
    Разработка пояснительной записки.
    Согласование и утверждение технического проекта.

    Рабочий проект

    Разработка программы

    Программирование и отладка программы

    Разработка программной документации

    Разработка программных документов в соответствии с требованиями ГОСТ 19.101-77.

    Испытания программы

    Разработка, согласование и утверждение программы и методики испытаний.
    Проведение предварительных государственных, межведомственных, приемо-сдаточных и других видов испытаний.
    Корректировка программы и программной документации по результатам испытаний.

    Внедрение

    Подготовка и передача программы

    Подготовка и передача программы и программной документации для сопровождения и (или) изготовления.
    Оформление и утверждение акта о передаче программы на сопровождение и (или) изготовление.
    Передача программы в фонд алгоритмов и программ.

    Примечания:

    1. Допускается исключать вторую стадию разработки, а в технически обоснованных случаях - вторую и третью стадии. Необходимость проведения этих стадий указывается в техническом задании.

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

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

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

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

    • Номер издания программы или номер редакции. номер документа данного вида, номер части документа присваиваются в порядке возрастания с 01 до 99. (Если документ состоит из одной части, то дефис и порядковый номер части не указывают).

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

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

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

    Программный документ может быть представлен на различных типах носителей данных и состоит из следующих условных частей:
    титульной;
    информационной;
    основной.

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

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

    Программные документы оформляют:

    • на листах формата А4 (ГОСТ 2.301-68) при изготовлении документа машинописным или рукописным способом;

    • допускается оформление на листах формата А3;

    • при машинном способе выполнения документа допускаются отклонения размеров листов, соответствующих форматам А4 и А3, определяемые возможностями применяемых технических средств; на листах форматов А4 и А3, предусматриваемых выходными характеристиками устройств вывода данных, при изготовлении документа машинным способом;

    • на листах типографических форматов при изготовлении документа типографским способом.

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

    титульная часть:

    • лист утверждения (не входит в общее количество листов документа);

    • титульный лист (первый лист документа);

    информационная часть:

    • аннотация;

    • лист содержания;

    основная часть:

    • текст документа (с рисунками, таблицами и т.п.)

    • перечень терминов и их определений;

    • перечень сокращений;

    • приложения;

    • предметный указатель;

    • перечень ссылочных документов;

      1   2


    написать администратору сайта