Описание алгоритма (проектной процедуры)

Описание алгоритма (проектной процедуры) — документ в составе комплекта технической документации на автоматизированную систему. Предусмотрен КСАС. Разрабатывается на стадии технического проекта.

Стандарты

ГОСТ 34.201— 2020, п. 3

Общие сведения о документе

Стадия создания	Код документа	Часть проекта	Принадлежность к		Дополнительные указания
			проектно-сметной документации	эксплуатационной документации
ТП	ПБ	МО	—	—	Допускается включать в документы П2, ПЗ или П4

ГОСТ Р 59795—2021, п. 10.1

Требования к содержанию документов с решениями по математическому обеспечению

1. Документ «Описание алгоритма (проектной процедуры)» в зависимости от специфики АС допускается разрабатывать как документ «Описание алгоритма» или как документ «Описание проектной процедуры (операции)».

2. Документ «Описание алгоритма» должен содержать разделы:

• назначение и характеристики алгоритма;
• используемая информация;
• результаты решения;
• математическое описание;
• алгоритм решения.
  

3. В разделе «Назначение и характеристики алгоритма» приводят:

• назначение алгоритма (его части);
• обозначение документа (документов) «Описание постановки задачи», для решения которой он предназначен;
• обозначение документа «Описание алгоритма», с которым связан данный алгоритм (при необходимости);
• краткие сведения о процессе (объекте), при управлении которым используют алгоритм, а также воздействия на процесс с точки зрения пользователя, осуществляемые при функционировании алгоритма;
• ограничения на возможность и условия применения алгоритма и характеристики качества решения (точность, время решения и т. д.);
• общие требования к входным и выходным данным (форматам, кодам и т. д.), обеспечивающие информационную совместимость решаемых задач в системе.
  

Примечание — При включении документа в виде раздела в документ «Описание постановки задачи» краткие сведения о процессе (объекте) не приводят.

4. В разделе «Используемая информация» приводят перечень массивов информации и (или) перечень сигналов, используемых при реализации алгоритма, в том числе:

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

По каждому массиву приводят:

• наименование, обозначение и оценочный объем;
• перечень наименований и обозначений используемых (или неиспользуемых) реквизитов и (или) входных переменных задачи или ссылку на документы, содержащие эти данные.
  

Примечания
1) Перечень используемых реквизитов приводят в том случае, если для данного массива в проектную документацию не включен документ «Описание массива информации» или число реквизитов в документе «Описание массива информации» меньше числа используемых в алгоритме реквизитов.
2) Перечень неиспользуемых реквизитов приводят, если число используемых реквизитов в документе «Описание массива информации» больше числа неиспользуемых в алгоритме реквизитов.

5. В разделе «Результаты решения» приводят перечень массивов информации и (или) перечень сигналов, формируемых в результате реализации алгоритма, в том числе:

• массивы информации и (или) сигналы, формируемые для выдачи выходных сообщений (документов, сигналов и т. д.);
• массивы информации, сохраняемой для решения данной и других задач АС.
  

По каждому массиву приводят:

• наименование, обозначение и оценочный объем;
• перечень наименований и обозначений реквизитов и (или) выходных переменных, используемых для формирования выходных сообщений, или ссылку на документы, содержащие эти данные.
  

6. В разделе «Математическое описание» приводят:

• математическую модель или математическое описание процесса (объекта);
• перечень принятых допущений и оценки соответствия принятой модели реальному процессу (объекту) в различных режимах и условиях работы;
• сведения о результатах НИР, если они использованы для разработки алгоритма.
  

7. В разделе «Алгоритм решения» приводят:

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

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

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

7.3. Алгоритм представляют одним из следующих способов:

• графический (в виде схемы);
• табличный;
• текстовый;
• смешанный (графический или табличный с текстовой частью).
  

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

7.4. Алгоритм в виде схемы выполняют по правилам, установленным ГОСТ 19.701 или ГОСТ 19.005.
Алгоритм в виде таблиц выполняют по правилам, установленным ГОСТ Р 2.105.
Алгоритм в виде текстового описания выполняют по правилам, установленным ГОСТ 24.301.

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

8. Допускается иллюстрационный материал, таблицы или текст вспомогательного характера давать в виде приложения.

9. При разработке документа «Описание проектной процедуры (операции)» допускается объединять в одном документе описание нескольких проектных процедур (операций).

9.1. Документ «Описание проектной процедуры (операции)» должен содержать:

• введение;
• описание;
• метод выполнения;
• схема алгоритма;
• требования к разработке программы.
  

9.2. Во введении приводят назначение проектной процедуры (операции), область и специфику ее применения.

9.3. В разделе «Описание» приводят содержание и (или) формализованное описание выполнения проектной процедуры (операции).
В содержательном описании излагают сущность выполнения проектной процедуры (операции), приводят, при необходимости, чертежи, схемы, графики, раскрывающие ее смысл. Указывают обозначение исходных данных и результаты их обработки.
Условные обозначения должны отражать символику, принятую в соответствующей предметной области. Излагают инженерную сущность технических ограничений, обосновывают выбор критериев оптимальности. При необходимости указывают ссылки на документы, имеющие отношение к выполнению данной проектной процедуры (операции).
Формализованное описание содержит:

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

9.4. В разделе «Метод выполнения» приводят предлагаемый метод выполнения проектной процедуры (операции). При необходимости приводят чертежи, схемы, поясняющие и раскрывающие сущность предлагаемого метода.
Если реализуемая проектная процедура (операция) имеет нетривиальную математическую интерпретацию, то следует дать ей объяснение или указать источники, которые обеспечивают всестороннее понимание метода.

9.5. В разделе «Схема алгоритма» приводят схему алгоритма выполнения проектной процедуры (операции). Схему алгоритма выполняют по ГОСТ 19.701.

9.6. В разделе «Требования к разработке программы» приводят:

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

Практика

Документ «Описание алгоритма» содержит формализованное описание алгоритма вычислений, которые необходимо совершить при выполнении некоторой задачи АС. С точки зрения порядка проектирования системы, он представляет собой ответ на постановку этой задачи, приведенную в описании постановки задач (комплекса задач). Составление документа целесообразно, когда алгоритм нетривиален, а его разработка (или адаптация уже существующего алгоритма к конкретному случаю) требует усилий квалифицированного специалиста: математика, биоинформатика и т. п. — в зависимости от предметной области.

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

Шаблоны

Шаблон	Описание
Филогост	Комплект шаблонов и пустографок для Microsoft Word