18c0693f

Документирование программных изделий ЕСПД

Детализация

Применяется для детализация некоторой программы, представленной в данной схеме одним символом
XB4 - идентификатор программы;
015 - номер листа, где приведено начало детализируемой программы;
B3 - координаты зоны листа		 Применяется (в отличие от случая, когда применяется символ "Предопределенный процесс") для детализации в составе данной схемы программы
Детализируемая программа начинается и заканчивается символом "Пуск-останов".
Внутри символа, посредством которого представлена детализируемая программа, проводят горизонтальную линию.
В данном примере детализируемая программа представлена посредством символа "Процесс".
Слева над горизонтальной линией помещается идентификатор детализируемой программы, а справа - номер листа и координата зоны, где размещен символ "Пуск-останов".
Внутри символа "Пуск-останов", обозначающего начало детализируемой программы, указывается идентификатор данной программы.


Документирование программных изделий

Проекты и курсовые работы, выполняемые студентами и связанные с разработкой программных изделий должны оформляться в соответствии с требованиями, предъявляемыми Единой Системой Программной Документации (ЕСПД). ЕСПД является набором государственных стандартов, который определяет:
  • Стадии и этапы разработки, виды и обозначения программных документов.
  • Общие требования к оформлению текстовых программных документов.
  • Требования к содержанию и оформлению отдельных программных документов.
  • Схемы алгоритмов. Полный перечень стандартов, входящих в состав ЕСПД, приведен в следующей таблице
    ГОСТ 19.001-77 Общие положения
    ГОСТ 19.002-80 Схемы алгоритмов и программ. Правила выполнения
    ГОСТ 19.003-80 Схемы алгоритмов и программ. Обозначения условные графические
    ГОСТ 19.004-80 Термины и определения
    ГОСТ 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 Правила внесения изменений в программные документы, выполненные печатным способом


    если пояснение не помещается внутри

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


    Компактное представление множества носителей данных одинакового вида

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


    Линии потока

    Применяют для указания направления линии потока:
    можно без стрелки, если линия направлена слева направо и сверху вниз;
    со стрелкой - в остальных случаях
    Излом линии потока под углом 90о Обозначает изменение направлений линии потока
    Пересечение линий потока Применяется в случае пересечения двух несвязанных линий потока
    Слияние линий потока Применяется в случае слияния линий потока, каждая из которых направлена к одному и тому же символу на схеме
    Место слияния линий потока допускается обозначать точкой или цифрой 0.
    место слияний линий потока обозначено точкой
    место слияний линий потока обозначено цифрой 0


    Лист утверждения

    Лист утверждения (ЛУ) выпускается на каждый программный документ на листах бумаги формата А4 .
    Обозначение листа утверждения состоит из обозначения документа, к которому относится ЛУ, и через дефис - шифра ЛУ.
    ЛУ не входит в общее число листов документа.
    ЛУ вносят в спецификацию после утвержденного документа и хранят на предприятии - держателе подлинника документа. Лист утверждения спецификации также вносят в данную спецификацию.
    ЛУ заполняют по форме, приведенной на чертеже ниже:


    где:
  • Поле 1 - наименование министерства или ведомства, в систему которого входит организация, разработавшая данный документ, заполняется по требованию заказчика. Выше поля 1, в правом верхнем углу, при необходимости, ставят специальную отметку (гриф секретности, указание "С предприятия не выносить" и т.п.).
  • Поле 2 - в левой части поля - должности и подписи лиц, согласовавших документ от организации заказчика при необходимости, в правой части поля - должность и подпись лица, утвердившего документ от организации разработчика. Справа от каждой подписи - инициалы и фамилия лица, подписавшего документ, а ниже подписи - дата подписания.
  • Поле 3 - полное наименование программы или программного изделия.
  • Поле 4 - обозначение документа и указание вида носителя данных (для документов на носителе данных).
  • Поле 5 - общее количество листов утверждения, например, "Листов 3". (Для одного листа поле не заполняется);
  • Поле 6 - в правой части поля - должности и подписи руководителей организации, выпустившей документ, руководителя разработки, исполнителей разработки документа и нормоконтроллера. Справа от каждой подписи - инициалы и фамилия лица, подписавшего документ, а ниже подписи - дата подписания.
  • Поле 7 - год издания документа.
  • Поле 8 - отметка об учете и хранении.
  • Поле 9 - строка изменений.
  • Поле 10 - литера документа. Пример заполнения ЛУ показан ниже:


    Межстраничный соединитель

    Первая строка внутри межстраничного соединителя определяет номер листа схемы, вторая - координату символа. а). Связываемые линией потока символы находятся на разных листах
    A3 - определяет зону на данном листе, где расположен символ "Комментарий"
    010E3 - определяет номер листа и зону расположения, связываемую с символом E3     		б). в случае связи некоторого символа со многими другими символами, расположенными на разных листах, на входе этого символа помещают один символ "Межстраничный соединитель", внутри которого на первой строке помещают знак #, а на второй строке - координаты символа "Комментарий". Внутри символа "Комментарий" указывают номера страниц и координаты символов, связанных с поясняемым символом.


    Начало, прерывание и конец алгоритма или программы

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


    Обязательные символы

    1. Процесс Выполнение операции или группы операций, в результате которых изменяется значение, форма представления или расположение данных
    2. Решение Выбор направления выполнения алгоритма или программы в зависимости от некоторых переменных условий
    3. Модификация Выполнение операций, меняющих команды, или группы команд, изменяющих программу
    4. Предопределенный процесс Использование ранее созданных и отдельно описанных алгоритмов или программ
    5. Ручная операция Автономный процесс, выполняемый вручную или при помощи неавтоматически действующих средств
    6. Вспомогательная операция Автономный процесс, выполняемый устройством, не управляемым непосредственно процессором
    7. Слияние Объединение двух или более множеств в единое множество
    8. Выделение Удаление одного или нескольких множеств из единого множества
    9. Группировка Объединение двух или более множеств с выделением нескольких других множеств
    10. Сортировка Упорядочение множества по заданным признакам
    11. Ручной ввод Ввод данных вручную при помощи неавтономных устройства с клавиатурой, переключателей, кнопок
    12. Ввод-вывод Преобразование данных в форму, пригодную для обработки (ввод) или отображения результатов обработки (вывод)
    13. Неавтономная память Ввод-вывод данных в случае использования запоминающего устройства, управляемого непосредственно процессором
    14. Автономная память Ввод-вывод данных в случае использования запоминающего устройства, не управляемого непосредственно процессором
    15. Документ Ввод-вывод данных, носителем которых служит бумага
    16. Перфокарта Ввод-вывод данных, носителем которых служит перфокарта
    17. Колода перфокарт Отображение набора перфокарт
    18. Файл Представление организованных на основе общих признаков данных, характеризующих в совокупности некоторый объект обработки данных. Символ используется в сочетании с символами конкретных носителей данных, выполняющих функции ввода-вывода.
    19. Перфолента Ввод-вывод данных, носителем которых служит перфолента
    20. Магнитная лента Ввод-вывод данных, носителем которых служит магнитная лента
    21. Магнитный барабан Ввод-вывод данных, носителем которых служит магнитный барабан
    22. Магнитный диск Ввод-вывод данных, носителем которых служит магнитный диск
    23. Оперативная память Ввод-вывод данных, носителем которых служит магнитный сердечник
    24. Дисплей Ввод-вывод данных, если непосредственно подключенное к процессору устройство воспроизводит данные и позволяет оператору ЭВМ вносить изменения в процесс их обработки
    25. Канал связи Передача данных по каналам связи
    26. Линия потока Указание последовательности связей между символами
    27. Параллельные действия Начало или окончание двух или более одновременно выполняемых операций
    28. Соединитель Указание связи между прерванными линиями потока, соединяющими символы
    29. Пуск-останов Начало, конец, прерывание процесса обработки данных или выполнения программы
    30. Комментарий Связь между элементом схемы и пояснением


    Общие требования к оформлению текстовых программных документов

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

    Общие требования к оформлению

    При выполнении программного документа машинописным или машинным способом документ выполняется на одной стороне листа, с такими интервалы между строк, которые обеспечивают пригодность к микрофильмированию
    При выполнении типографским способом документ выполняется в соответствии с требованиями, предъявляемыми к изданиям, изготовляемым типографским способом
    При выполнении части рукописным способом - на одной стороне листа, черными чернилами или тушью, чертежным шрифтом с высотой букв не менее 2,5 мм.
    При выполнении программного документа машинописным, машинным или рукописным способами разрешается вписывать в документы отдельные слова, формулы, условные знаки и т.п., а также исправлять опечатки и графические неточности от руки чертежным шрифтом. Построение документа При необходимости допускается делить документ на части. Деление на части осуществляется на уровне не ниже раздела и каждую часть комплектуют отдельно, в конце содержания первой части перечисляют обозначения остальных частей. Нумерацию страниц документа, а также нумерацию разделов, рисунков и таблиц производят в пределах каждой части. Каждую часть начинают с титульного листа. Лист утверждения выпускают на весь документ с обозначением первой части. Если в документ включаются части текста программы то их можно оформлять в соответствии с правилами языка, на котором написан текст программы. Информационная и основная части программного документа выполняются по форме 1:
    Форма 1

    или по форме 2
    Форма 2

    где:
  • Поле 1 - порядковый номер страницы.
  • Поле 2 - обозначение документа.
  • Поле 3 - текст документа.
  • Поле 4 - строка изменений. Рамку формата можно не наносить. Аннотацию размещают на отдельной пронумерованной странице с заголовком "АННОТАЦИЯ", но не нумеруют как раздел. В аннотации указывают издание программы, кратко излагают назначение и содержание документа, общее количество частей документа (если их больше одной). Содержание документа размещают на отдельной пронумерованной странице/страницах после аннотации, снабжают заголовком "СОДЕРЖАНИЕ", не нумеруют как раздел и включают в общее количество страниц документа.
    В содержание документа включают номера разделов, подразделов, пунктов и подпунктов, имеющих заголовок, их наименование и номера страниц; прочие наименования (перечень рисунков, таблиц и т.п.) и номера страниц. Наименования, включенные в содержание, записывают строчными буквами. Структурными элементами текста документа являются разделы, подразделы, пункты, подпункты и перечисления.
  • Раздел - первая ступень деления, обозначенная номером и снабженная заголовком.
  • Подраздел - часть раздела, обозначенная номером и имеющая заголовок.
  • Пункт- часть раздела или подраздела, обозначенная номером. Может иметь заголовок.
  • Подпункт- часть пункта, обозначенная номером. Может иметь заголовок.
  • Внутри подразделов, пунктов, подпунктов могут быть даны перечисления, которые рекомендуется обозначать арабскими цифрами со скобкой: 1), 2) и т.д. Допускается выделять перечисления простановкой дефиса перед текстом. Не рекомендуется делать ссылки на элементы перечисления.
  • Абзац - логически выделенная часть текста, не имеющая номера. Разрешается помещать текст между заголовками раздела и подраздела, между заголовками подраздела и пункта. Заголовки разделов пишут прописными буквами и размещают по центру строки. Заголовки подразделов записывают с абзаца строчными буквами (кроме первой прописной). Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят, но если заголовок состоит из двух предложений, их разделяют точкой.
    Каждый раздел рекомендуется начинать с нового листа.
    При машинном способе выполнения документа можно заголовки подразделов и пунктов записывать шрифтом, имеющемся на печатающем устройстве.
    Расстояние между основаниями строк заголовка принимают таким, как в тексте. Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой. В пределах раздела должна быть сквозная нумерация по всем подразделам, пунктам и подпунктам, входящим в данный раздел.
    Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделенные точкой (2.1, 3..1 и т.д.).


    При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т.д.).
    Ниже приведен пример структуры текста программного документа и нумерация его разделов, подразделов, пунктов и подпунктов:
    Текст документа Текст документа должен быть кратким, четким, исключающим возможность неоднозначного толкования.
    Термины и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии - общепринятым в научно-технической литературе, и приводиться в перечне терминов.
    Для выделения основных понятий допускается изменять интервалы между словами, а также печатать отдельные слова и части текста шрифтом, отличным от печати основного текста,
    Необходимые пояснения к тексту документа могут оформляться сносками. Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего образа шрифта, например, "печатающее устройство2)". Иллюстрации Иллюстрации могут быть расположены в тексте документа и/или в приложениях. Иллюстрации нумеруются арабскими цифрами в пределах всего документа. В приложениях иллюстрации нумеруются в пределах приложения.
    Ссылки на иллюстрации дают по типу: "рис.2" или "(рис.2)". Ссылки на ранее упомянутые иллюстрации дают по типу: "см. рис.2".
    Иллюстрации могут иметь наименование и подрисуночный текст, поясняющий содержание иллюстрации. Наименование помещают над иллюстрацией, подрисуночный текст - под ней. Номер иллюстрации помещают под поясняющим текстом. Формулы Формулы в документе нумеруются арабскими цифрами , номер ставят с правой стороны страницы, в скобках, на уровне формулы. В пределах всего документа или его частей формулы имеют сквозную нумерацию.
    Ссылки в тексте на порядковый номер формулы дают в скобках, например: "в формуле (3)".
    Значения символов и числовых коэффициентов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле.


    Первая строка расшифровки должна начинаться со слова "где", без двоеточия после него.
    Если в программном документе приведен перечень этих символов и числовых коэффициентов, значения их под формулой допускается не приводить.
    Размерность одного и того же параметра в пределах одного документа должна быть постоянной. Ссылки В программных документах допускаются ссылки на стандарты, технические условия и другие документы.. Ссылаться следует на документ в целом или его разделы и приложения (с указанием обозначения и наименования документа, номера и наименования раздела или приложения). При повторных ссылках на раздел или приложение указывают только номер. При ссылках на документ допускается проставлять в квадратных скобках его номер в соответствии с перечнем ссылочных документов.
    Ссылки на отдельные подразделы, пункты и иллюстрации другого документа не допускаются. Допускаются ссылки внутри документа на пункты, иллюстрации и отдельные подразделы. Таблицы Цифровой материал для достижения лучшей наглядности и сравнимости показателей рекомендуется оформлять в виде таблицы.
    Таблица может иметь заголовок, который следует выполнять строчными буквами.
    Сноски к таблицам располагают непосредственно под таблицей. Примечания В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.
    Одно примечание не нумеруется. После слова "Примечание" ставят точку. Несколько примечаний нумеруют по порядку арабскими цифрами с точкой. После слова "Примечания" ставят двоеточие. Сокращения В тексте и надписях под иллюстрациями допускаются сокращения слов, установленные стандартами и/или общепринятые в русском языке, а также сокращения, применяемых для обозначения программ, их частей и режимов работы, в языках управления заданиями, в средствах настройки программы и т.п.
    Если в документе принята особая система сокращения слов или наименований, то в нем должен быть приведен перечень сокращений. Приложения В виде приложений можно оформлять иллюстративный материал, таблицы или текст вспомогательного характера.Приложения могут быть продолжением данного документа на последующих страницах или выпускаться в виде отдельного документа. Нумерация страниц документа и приложений, входящих в состав документа, должна быть сквозная, если приложения не выполняются отдельным документом.
    Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова "ПРИЛОЖЕНИЕ" прописными буквами и иметь тематический заголовок При наличии в документе более одного приложения все приложения нумеруют в арабскими цифрами (без знака ¦).
    Содержание каждого приложения, при необходимости, разбивают на разделы, подразделы, пункты, нумеруемые отдельно по каждому приложению. Иллюстрации и таблицы в приложениях нумеруют в пределах каждого приложения.
    На приложения должны быть даны ссылки в основном тексте документа. Все приложения должны быть перечислены в листе "Содержание".
    Оглавление


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

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

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

    Аннотация и содержание обязательны. Текст документа должен состоять из следующих разделов:
  • Назначение программы - назначение, возможности программы, ее основные характеристики, ограничения, накладываемые на область применения программы.
  • Условия применения - условия, необходимые для выполнения программы (требования к необходимым для данной программы техническим средствам и другим программам, общие характеристики входной и выходной информации, а также требования и условия организационного, технического и технологического характера и т.п.).
  • Описание задачи - определения задачи и методы ее решения.
  • Входные и выходные данные - сведения о входных и выходных данных. В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы. В приложение могут быть включены справочные материалы (иллюстрации, таблицы, графики, примеры и т.п.). Перечень документов

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

    Аннотация и содержание обязательны. Описание программы должно содержать следующие разделы:
  • Общие сведения - обозначение и наименование программы; программное обеспечение, необходимое для функционирования программы; языки программирования, на которых написана программа.
  • Функциональное назначение - классы решаемых задач и/или назначение программы и сведения о функциональных ограничениях на ее применение.
  • Описание логической структуры - алгоритм программы; используемые методы; структура программы с описанием функций составных частей и связи между ними; связи программы с другими программами. Описание логической структуры программы выполняют с учетом текста программы на исходном языке.
  • Используемые технические средства - типы ЭВМ и устройств, которые используются при работе программы.
  • Вызов и загрузка - способы вызова программы с соответствующего носителя данных; входные точки в программу. Допускается здесь указывать адреса загрузки, сведения об использовании оперативной памяти, объем программы.
  • Входные данные - характер, организация и предварительная подготовка входных данных, формат, описание и способ кодирования входных данных.
  • Выходные данные - характер и организация выходных данных; формат, описание и способ кодирования выходных данных. В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.
    Допускается содержание разделов иллюстрировать пояснительными примерами, таблицами, схемами, графиками.
    В приложение к описанию программы допускается включать различные материалы, которые нецелесообразно включать в текст описания.     Перечень документов

    Параллельные действия

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


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

    Аннотация и содержание необязательны. Пояснительная записка должна содержать следующие разделы:
  • Введение - наименование программы и ее условное обозначение, а также документы, на основании которых ведется разработка, с указанием организации и даты утверждения.
  • Назначение и область применения - назначение программы, краткая характеристика области применения программы.
  • Технические характеристики - раздел должен содержать следующие подразделы:
  • постановка задачи на разработку программы, описание применяемых математических методов и, при необходимости, описание допущений и ограничений, связанных с выбранным математическим аппаратом;
  • описание алгоритма и (или) функционирования программы с обоснованием выбора схемы алгоритма решения задачи, возможные взаимодействия программы с другими программами;
  • описание и обоснование выбора метода организации входных и выходных данных;
  • описание и обоснование выбора состава технических и программных средств на основании проведенных расчетов и/или анализов, распределение носителей данных, которые использует программа.
  • Ожидаемые технико-экономические показатели - технико-экономические показатели, обосновывающие преимущество выбранного варианта технического решения, а также, при необходимости, ожидаемые оперативные показатели.
  • Источники, использованные при разработке - перечень научно-технических публикаций, нормативно-технических документов и других научно-технических материалов, на которые есть ссылки в основном тексте. В зависимости от особенностей документа отдельные разделы/подразделы допускается объединять, а также вводить новые. В приложение к документу могут быть включены обоснования, методики, расчеты и другие документы, использованные при разработке. Перечень документов

    Правила выполнения схем

    Отдельные функции алгоритмов и программ, с учетом степени их детализации, отображаются в виде условных графических обозначений - символов (см.). Для облегчения вычерчивания и нахождения на схеме символов рекомендуется поле листа разбивать на зоны. Размеры зон устанавливают с учетом минимальных размеров символов, изображенных на данном листе. Допускается один символ размещать в двух и более зонах, если размер символа превышает размер зоны. Координаты зоны проставляют:
    по горизонтали - арабскими цифрами слева направо в верхней части листа;
    по вертикали - прописными буквами латинского алфавита сверху вниз в левой части листа.
    Координаты зон в виде сочетания букв и цифр присваивают символам, вписанным в поля этих зон, например: A1, A2, A3, B1, B2, B3 и т.д. Если поле листа не разбито на зоны, символам присваивают порядковые номера. В пределах одной схемы допускается применять не более двух смежных размеров ряда чисел, кратных 5. Линии потока должны быть параллельны линиям внешней рамки схемы.
    Направления линий потока сверху вниз и слева направо принимают за основные и, если линии потока не имеют изломов, стрелками можно не обозначать. В остальных случаях направление линии потока обозначать стрелкой обязательно. Расстояние между параллельными линиями потока должно быть не менее 3 мм, между остальными символами схемы - не менее 5 мм. Записи внутри символа или рядом с ним должны выполняться машинописью или чертежным шрифтом. Записи должны быть краткими. Сокращения слов и аббревиатуры, за стандартных и общепринятых, должны быть расшифрованы в нижней части поля схемы или в документе, к которому эта схема относится.
    Записи внутри символа должны быть представлены так, чтобы их можно было читать слева направо и сверху вниз, независимо от направления потока. (Вид а должен быть прочитан как вид б).
    В схеме символу может быть присвоен идентификатор, который должен помещаться слева над символом (например, для ссылки в других частях документации):
    В схемах допускается краткая информация о символе (описание, уточнение или другие перекрестные ссылки для более полного понимания функции данной части системы). Описание символа должно помещаться справа над символом:


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

    Аннотация и содержание необязательны. Программа и методика испытаний должна содержать следующие разделы:
  • Объект испытаний - наименование, область применения и обозначение испытуемой программы.
  • Цель испытаний - цель проведения испытаний.
  • Требования к программе - требования, подлежащие проверке во время испытаний и заданные в техническом задании на программу.
  • Требования к программной документации - состав программной документации, предъявляемой на испытания, и специальные требования, если они заданы в техническом задании.
  • Средства и порядок испытаний - технические и программные средства, используемые во время испытаний, а также проведения порядок испытаний.
  • Методы испытаний - описания используемых методов испытаний. Методы испытаний рекомендуется по отдельным показателям располагать в последовательности, в которой эти показатели расположены в разделах "Требования к программе" и "Требования к программной документации". В методах испытаний должны быть приведены описания проверок с указанием результатов проведения испытаний (перечней тестовых примеров, контрольных распечаток тестовых примеров и т.п.).; В зависимости от особенностей документа допускается вводить дополнительные разделы. В приложение к документу могут быть включены тестовые примеры, контрольные распечатки тестовых примеров, таблицы, графики и т.п. Перечень документов

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

    Документация, разработанная на программу, может использоваться для реализации и передачи программы на носителях данных, а также для изготовления программного изделия. К программным относят документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ, а именно:
  • Спецификация - содержит состав программы и документации на нее. Выполняется на стадии рабочего проекта. Является обязательным документом для комплексов и тех компонентов, которые могут иметь самостоятельное применение.
  • Ведомость держателей подлинников (код вида документа - 05) - содержит перечень предприятий, на которых хранят подлинники программных документов. Выполняется на стадии рабочего проекта. Необходимость составления документа на этапе утверждения технического задания (по согласованию).
  • Текст программы (код вида документа - 12) - содержит запись программы с необходимыми комментариями. Выполняется на стадии рабочего проекта. Необходимость - по согласованию.
  • Описание программы (код вида документа - 13) - содержит сведения о логической структуре и функционировании программы. Выполняется на стадии рабочего проекта. Необходимость - по согласованию.
  • Программа и методика испытаний (код вида документа - 51) - содержит требования, подлежащие проверке при испытаниях программы, а также порядок и методы их контроля. Выполняется на стадии рабочего проекта. Необходимость - по согласованию.
  • Техническое задание - содержит назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний. Выполняется на стадии технического задания и является обязательным документом для комплекса. Необходимость составления технических заданий на компоненты определяется по согласованию с заказчиком.
  • Пояснительная записка (код вида документа - 81) - содержит схему алгоритма, общее описание алгоритма и /или функционирования программы, а также обоснование принятых технических и технико-экономических решений.
    Выполняется на стадии эскизного и технического проектов. Необходимость - по согласованию.
  • Эксплуатационные документы - содержит сведения для обеспечения функционирования и эксплуатации программы. Выполняются на стадии рабочего проекта. Необходимость - по согласованию для каждого документа отдельно. К эксплуатационным относятся следующие документы:
  • Ведомость эксплуатационных документов (код вида документа - 20) - содержит перечень эксплуатационных документов на программу.
  • Формуляр (код вида документа - 30) - содержит основные характеристики программы, комплектность и сведения об эксплуатации программы.
  • Описание применения (код вида документа - 31) - содержит сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств.
  • Руководство системного программиста (код вида документа - 32) - содержит сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения.
  • Руководство программиста (код вида документа - 33) - содержит сведения для эксплуатации программы .
  • Руководство оператора (код вида документа - 34) - содержит сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы .
  • Описание языка (код вида документа - 35) - содержит описание синтаксиса и семантики языка.
  • Руководство по техническому обслуживанию (код вида документа - 46) - содержит сведения для применения тестовых и диагностических программ при обслуживании технических средств. Помимо оговариваемых стандартом, на программу могут выпускаться и другие программные и эксплуатационные документы, им присваиваются коды от 90 до 99. Можно объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра). В объединенных документах должны содержаться сведения, которые необходимо включать в каждый объединяемый документ. Обозначение программ и документов состоит из групп знаков, разделенных точками (после кода страны и кода организации-разработчика), пробелами (после номера редакции документа и кода вида документа), дефисами (после регистрационного номера и номера документа данного вида). Программа и ее документ - спецификация имеют следующую структуру обозначения: Структура обозначения других программных документов: Кода страны-разработчика и код организации-разработчика присваивают в установленном порядке Регистрационный номер присваивается в порядке возрастания, начиная с 00001 до 99999, для каждой организации-разработчика. Номер издания программы или номер редакции.номер документа данного вида, номер части документа присваиваются в порядке возрастания с 01 до 99. (Если документ состоит из одной части, то дефис и порядковый номер части не указывают.) Номер редакции спецификации и ведомости эксплуатационных документов на программу должны совпадать с номером издания этой же программы.
    Оглавление


    Рекомендуемые символы

    1. Межстраничный соединитель Указание связи между разъединенными частями схем алгоритмов и программ, расположенных на разных листах
    2. Магнитная карта Ввод-вывод данных, носителем которых служит магнитная карта
    3. Ручной документ Формирование документа в результате выполнения ручных операций
    4. Архив Хранение комплекта упорядоченных носителей данных в целях повторного применения
    5. Автономная обработка Преобразование исходных данных в результате выполнения автономной операции
    6. Расшифровка Считывание с носителя данных, перекодирование и печать на том же или другом носителе данных в результате выполнения автономной операции
    7. Кодирование Нанесение кодированной информации на носитель в результате выполнения автономной операции
    8. Копирование Образование копии носителя в результате выполнения автономной операции
    9. Транспортирование носителей Перемещение носителей данных при помощи транспортных средств или курьером
    10. Материальный поток Указание последовательности операций в технологическом процессе изготовления предметов труда, направление их перемещения
    11. Источник (приемник данных) Отправитель или получатель данных


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

    Аннотация и содержание обязательны. Руководство оператора должно содержать следующие разделы:
  • Назначение программы - сведения о назначении и информация, достаточная ля понимания функций программы и ее эксплуатации.
  • Условия выполнения программы - условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратурных и программных средств и т.п.).
  • Выполнение программы - последовательность действий оператора, обеспечивающих загрузку, запуск и завершение программы, приведено описание функций, форматов и возможных вариантов команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды.
  • Сообщения оператору - тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующих действий оператора (действия оператора в случае сбоя, возможности повторного запуска программы и т.п.). В зависимости от особенностей документа допускается объединять отдельные разделы и вводить новые.
    Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками. В приложения к руководству оператора допускается включать различные материалы, которые нецелесообразно включать в разделы руководства. Перечень документов

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

    Аннотация и содержание обязательны. Руководство по техническому обслуживанию должно содержать следующие разделы:
  • Введение - назначение руководства, перечень эксплуатационных документов, которыми должны дополнительно к руководству пользоваться при техническом обслуживании.
  • Общие указания - порядок технического обслуживания, указания по организации и особенностям его проведения.
  • Требования к техническим средствам - минимальный состав технических средств, обеспечивающий работу программы.
  • Описание функций:
  • максимальный состав технических средств, проверяемых этой программой;
  • описание совместного функционирования технических средств и программы с указанием метода обработки ошибок;
  • описание организации входных и выходных данных, используемых при обслуживании технических средств;
  • описание взаимодействий устройств с программой, результатов взаимодействий, с выводом результатов работы программы. В зависимости от особенностей документа допускается вводить дополнительные разделы. Перечень документов
    Оглавление


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

    Аннотация и содержание обязательны. Руководство программиста должно содержать следующие разделы:
  • Назначение и условия применения - назначение и функции, условия, необходимые для выполнения (объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению).
  • Характеристики программы - описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т.п.)..
  • Обращение к программе - описание процедур вызова программы (способы передачи управления и параметров данных и др.).
  • Входные и выходные данные - описание организации входной и выходной информации и, при необходимости, ее кодирования.
  • Сообщения -тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям. В зависимости от особенностей документа допускается объединять отдельные разделы и вводить новые. В приложении к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.). Перечень документов

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

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

    Соединитель

    E5, B1, A, 5 - идентификаторы соединителей в виде:
    буквы и цифры (координаты зоны листа) При большой насыщенности схемы символами отдельные линии потока между удаленными друг от друга символами допускается обрывать. При этом в конце (начале) обрыва должен быть помещен символ "Соединитель"
    буквы
    цифры


    Соотношение геометрических размеров символов

    Размер a должен выбираться из ряда 10, 15, 20 мм. Допускается увеличивать размер a на число, кратное 5. Размер b равен 1,5a.
    П р и м е ч а н и е. При ручном выполнении схем алгоритмов и программ для обязательных символов 1-5, 11, 12, 16, 29 и рекомендуемых символов 3 и 4 допускается устанавливать b равным 2a. Обязательные символы 7-10, 14 и рекомендуемый символ 8 допускается представлять в виде равнобедренного треугольника с катетом a.
    При выполнении условных графических обозначений автоматизированным методом размеры геометрических элементов символов округляются до значений, определяемых техническими возможностями используемых устройств.
    Оглавление


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

    Спецификация является основным программным документом для компонентов, применяемых самостоятельно, и для комплексов. Форма спецификации приведена на рисунке ниже:.
    Спецификация в общем случае должна содержать разделы:
  • документация;
  • комплексы;
  • компоненты. Аннотацию и содержание можно не включать в документ. Наименование каждого раздела указывают в виде заголовка в графе "Наименование", заголовок подчеркивают. Далее записывают заимствованные программные документы. в порядке возрастания кодов организаций - разработчиков и далее в порядке возрастания кода вида документа. После каждого раздела спецификации необходимо оставлять несколько свободных строк для дополнительных записей. Графы спецификаций заполняют следующим образом:
  • в графе "Обозначение":
  • в разделе "Документация" - обозначения записываемых документов программы;
  • в разделе "Комплексы" - обозначения спецификаций комплексов, входящих в данный комплекс;
  • в разделе "Компоненты" - обозначения основных программных документов компонентов;
  • в графе "Наименование":
  • в разделе "Документация" - наименование и вид документа для документов на данную программу; полное наименование программы, наименование и вид документа для заимствованных документов;
  • в разделах "Комплексы" и "Компоненты" - полное наименование программы, наименование и вид документа;
  • в графе "Примечание" - дополнительные сведения, относящиеся к записанным в спецификации программам. При отсутствии места в графе "Примечание" допускается записывать только порядковые номера примечаний, а текст примечаний - в конце соответствующих разделов спецификации. Можно текст примечаний записывать на последних листах спецификации без граф с проставлением порядкового номера примечания. В графе "Обозначение" запись производят в одну строку. В остальных графах спецификации записи допускаются в несколько строк. Перечень документов

    Стадии и этапы разработки

    Ниже перечисляются общие стадии и этапы разработки программных изделий, устанавливаемые стандартом. В обоснованных случаях допускается исключать стадии экскизного и технического проекта - необходимость этого выявляется на стадии технического задания. По согласованию с заказчиком можно объединять, исключать, вводить другие этапы и изменять их содержание. Стадия ТЕХНИЧЕСКОЕ ЗАДАНИЕ состоит из следующих этапов
  • Обоснование необходимости разработки программы - на этом этапе выполняются:
  • постановка задачи;
  • сбор исходных материалов;
  • выбор и обоснование критериев эффективности и качества разрабатываемой программы;
  • обоснование необходимости проведения научно-исследовательских работ.
  • Научно-исследовательские работы - на этом этапе выполняются:
  • определение структуры входных и выходных данных;
  • предварительный выбор методов решения задачи;
  • обоснование целесообразности применения ранее разработанных программ;
  • определение требований к техническим средствам;
  • обоснование принципиальной возможности решения поставленной задачи.
  • Разработка и утверждение технического задания - на этом этапе выполняются:
  • определение требований к программе;
  • разработка технико-экономического обоснования разработки программы;
  • определение стадий, этапов и сроков разработки программы и документации на нее;
  • выбор языков программирования;
  • определение необходимости проведения научно-исследовательских работ на последующих стадиях.
    Стадия ЭСКИЗНЫЙ ПРОЕКТ состоит из следующих этапов
  • Разработка эскизного проекта - на этом этапе выполняются:
  • предварительная разработка структуры входных и выходных данных.
  • уточнение методов решения задачи;
  • разработка общего описания алгоритма решения задачи;
  • разработка технико-экономического обоснования.
  • Утверждение эскизного проекта - на этом этапе выполняются:
  • разработка пояснительной записки;
  • согласование и утверждение эскизного проекта.
    Стадия ТЕХНИЧЕСКИЙ ПРОЕКТ состоит из следующих этапов
  • Разработка технического проекта - на этом этапе выполняются:
  • уточнение структуры входных и выходных данных;
  • разработка алгоритма решения задачи;
  • определение формы представления входных и выходных данных;
  • определение семантики и синтаксиса языка;
  • разработка структуры программы;
  • окончательное определение конфигурации технических средств.
  • Утверждение технического проекта - на этом этапе выполняются:
  • разработка плана мероприятий по разработке и внедрению программы;
  • разработка пояснительной записки;
  • согласование и утверждение технического проекта.

    Стадия РАБОЧИЙ ПРОЕКТ состоит из следующих этапов
  • Разработка программы - на этом этапе выполняется:
  • программирование и отладка программы.
  • Разработка программной документации - на этом этапе выполняется:
  • разработка программных документов в соответствии с требованиями ЕСПД
  • Испытания программы - на этом этапе выполняются:
  • разработка согласование и утверждение программы и методики испытаний;
  • проведение предварительных государственных, межведомственных, приемо-сдаточных и других видов испытаний;
  • корректировка программы и программной документации по результатам испытаний.

    Стадия ВНЕДРЕНИЕ состоит из единственного этапа
  • Подготовка и передача программы - на этом этапе выполняются:
  • подготовка и передача программы и программной документации для сопровождения и /или изготовления;
  • оформление и утверждение акта о передаче программы на сопровождение и/или изготовление;
  • передача программы в фонд алгоритмов и программ.

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

    Аннотацию и содержание допускается в документ не включать. Техническое задание должно содержать следующие разделы:
  • Введение - наименование, краткая характеристика, область применения программы и объекта, в котором используют программу.
  • Основание для разработки - документ/документы, на основании которых ведется разработка; организация, утвердившая этот документ, и дата его утверждения; наименование и/или условное обозначение темы разработки.
  • Назначение разработки - функциональное и эксплуатационное назначение программы.
  • Требования к программе или программному изделию - раздел должен содержать следующие подразделы:
  • Требования к функциональным характеристикам - требования к составу выполняемых функций, организации входных и выходных данных, временным характеристикам и т.д.
  • Требования к надежности - требования к обеспечению надежного функционирования (обеспечения устойчивого функционирования, контроль входной и выходной информации, время восстановления после отказа и т.п.).
  • Условия эксплуатации - условия эксплуатации (температура окружающего воздуха, относительная влажность и т.п. для выбранных типов носителей данных), при которых должны обеспечиваться заданные характеристики, а также вид обслуживания, необходимое количество и квалификация персонала.
  • Требования к составу и параметрам технических средств - необходимый состав технических средств с указанием их основных технических характеристик.
  • Требования к информационной и программной совместимости - требования к информационным структурам на входе и выходе и методам решения, исходным кодам, языкам программирования и программным средствам, используемым программой.
  • Требования к маркировке и упаковке - требования к маркировке программного изделия, варианты и способы упаковки.
  • Требования к транспортированию и хранению - транспортирования, места хранения, условия хранения, условия складирования, сроки хранения в различных условиях.
  • Специальные требования.
  • Требования к программной документации - предварительный состав программной документации и, при необходимости, специальные требования к ней.
  • Технико-экономические показатели - ориентировочная экономическая эффективность, предполагаемая годовая потребность, экономические преимущества разработки по сравнению с лучшими отечественными и зарубежными образцами или аналогами.
  • Стадии и этапы разработки - стадии разработки, этапы и содержание работ (перечень программных документов, которые должны быть разработаны, согласованы и утверждены), а также, как правило, сроки разработки и состав исполнителей.
  • Порядок контроля и приемки - виды испытаний и общие требования к приемке работы. В зависимости от особенностей программного изделия допускается уточнять содержание разделов, вводить новые разделы или объединять отдельные из них. В приложениях к техническому заданию, при необходимости, приводят:
  • перечень научно-исследовательских и других работ, обосновывающих разработку;
  • схемы алгоритмов, таблицы, описания, обоснования, расчеты и другие документы, которые могут быть использованы при разработке;
  • другие источники разработки. Перечень документов

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

    Аннотация и содержание не являются обязательными. Основная часть документа должна состоять из текстов одного или нескольких разделов, которым даны наименования. Допускается вводить наименование также и для совокупности разделов. Каждый из этих разделов характеризуется одним из типов символической записи, например:
  • символическая запись на исходном языке;
  • символическая запись на промежуточных языках;
  • символическое представление машинных кодов и т.п. В символическую запись разделов рекомендуется включать комментарии. Перечень документов

    Титульный лист

    Титульный лист заполняют по форме и правилам, установленным для ЛУ, но при этом:
  • Поле 1 - заполняется по требованию заказчика;
  • Поле 2 - не заполняется.
  • Поля 3,4 - как в ЛУ.
  • Поле 5 - указывают объем документа;
  • поле 6 - не заполняют;
  • Поля 7-10 - как в ЛУ. На титульном листе в левом верхнем углу должна быть надпись: Утвержден -------------- обозначение ЛУ Пример заполнения титульного листа приведен ниже:

    Информационная часть должна состоять из аннотации и содержания. Необходимость включения информационной части в различные виды программных документов установлена соответствующими стандартами ЕСПД на эти документы. В аннотации приводятся сведения о назначении документа и краткое содержание его основной части. Содержание включает в себя перечень записей о структурных элементах основной части документа, в каждую из которых входят:
  • обозначение структурного элемента (номер раздела, подраздела и т.п.);
  • наименование структурного элемента;
  • адрес структурного элемента на носителе данных (например, номер страницы, номер файла и т.п.). Состав и структура основной части программного документа устанавливаются стандартами ЕСПД на соответствующие документы. О каждом изменении программного документа делается запись в части регистрации изменений. Материалы программного документа располагают в следующей последовательности:
  • титульная часть
  • лист утверждения (не входит в общее количество листов документа);
  • титульный лист (первый лист документа);
  • информационная часть;
  • аннотация;
  • лист содержания;
  • основная часть;
  • текст документа (с рисунками, таблицами и т..п.);
  • приложения; 1)
  • перечень терминов; 1) 2)
  • перечень сокращений; 1) 2)
  • перечень рисунков; 1) 3)
  • перечень таблиц; 1) 3)
  • предметный указатель; 1) 2)
  • перечень ссылочных документов; 1)
  • перечень символов и числовых коэффициентов; 1) 2)
  • часть регистрации изменений;
  • лист регистрации изменений. 1) Включается в документ при необходимости
    2) Составляется в алфавитном порядке
    3) Составляется в порядке возрастания номеров

    Требования к содержанию и оформлению отдельных программных документов

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

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

    Программы можно идентифицировать и применять самостоятельно и /или в составе других программ. Программы подразделяются на компоненты и комплексы:
  • Компонент - программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса.
  • Комплекс - программа, состоящая из двух или более компонентов и /или комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса

    Возможные варианты обозначения символов в схемах

    B2, B3, C2 - координаты зоны листа, в которой размещен символ Координату зоны символа или порядковый номер проставляют слева в верхней части символа в разрыве его контура
    18, 19, 20 - порядковые номера символов на схеме
    Допускается не проставлять координаты символов при выполнении схем от руки и при наличии координатной сетки


    Возможные варианты отображения решения

    A=B, P>=0 - условия решений;
    A, B, P - параметры    		 При числе исходов не более трех признак условия решения (Да, Нет, =, >,
    yi - условие i-го исхода, 011T1, 016A3, 005B5, 015T4 - адреса исходов.
    Структура адреса имеет вид:     		При числе исходов более трех условие исхода проставляется в разрыве линии потока. Адрес исхода проставляется в продолжении условия исхода и отделяется от него пробелом;
    B5 - знак, указывающий, что условия решения даются в виде таблицы или символа "Комментарий", расположенных на данном листе в зоне B5 в символе "Соединитель" указывают координату зоны, куда должна помещаться таблица или символ "Комментарий";
    в таблице (в символе "Комментарий") приводят адреса всех исходов


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

    Применяют:
    при пересечении материальных потоков
    при объединении материальных потоков
    при разветвлении материальных потоков