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

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

ГОСТ 19.502-78 объясняет, как правильно оформлять и что писать в документе «Общее описание» для программ. В нем прописаны обязательные части: для чего нужна программа, при каких условиях она работает, какую задачу решает, а также какие данные принимает на вход и выдает на выходе. Документ обязательно должен содержать аннотацию и оглавление.

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

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

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

В ГОСТ 19.502-78 используются следующие ключевые понятия для документа «Общее описание»:

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

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

ГОСТ 19.502-78 входит в комплекс ЕСПД и определяет правила составления документа «Общее описание». Этот стандарт полностью повторяет международный стандарт СТ СЭВ 2093-80.

Основные положения и структура документа
* Документ оформляется по общим правилам стандартов ЕСПД.
* В нем обязательно должны быть аннотация и оглавление.
* Если нужно, можно добавлять новые разделы или объединять старые под особенности конкретной программы.

Обязательные разделы документа
В документе должны быть следующие части:
1. Назначение программы – возможности программы, ее главные характеристики и ограничения в применении.
2. Условия применения – что требуется для нормальной работы программы.
3. Описание задачи – суть решаемой задачи, включая математическую постановку, если это необходимо.
4. Входные и выходные данные – как устроена информация, поступающая в программу и выходящая из нее.

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

Часто задаваемые вопросы (FAQ) по стандарту ГОСТ 19.502-78 «ЕСПД. Описание применения (Общее описание). Требования к содержанию и оформлению»

1. Что представляет собой стандарт ГОСТ 19.502-78 и каково его главное назначение?

Ответ: Это государственный стандарт из системы ЕСПД. Он определяет, как должен выглядеть и что содержать документ «Общее описание» (в самом названии стандарта также указано «Описание применения»).

2. С какими международными стандартами гармонизирован данный документ?

Ответ: ГОСТ 19.502-78 полностью соответствует международному стандарту СТ СЭВ 2093-80.

3. Является ли обязательным включение информационной части в состав документа «Общее описание»?

Ответ: Да. Вторая статья стандарта прямо говорит, что аннотация и оглавление в «Общем описании» должны быть обязательно.

4. Каковы требования к общей структуре и оформлению документа?

Ответ: Документ нужно оформлять по общим стандартам Единой системы программной документации.

5. Какие обязательные разделы должен содержать текст документа?

Ответ: Третий пункт стандарта требует наличия четырех разделов:
1. Назначение программы.
2. Условия применения.
3. Описание задачи.
4. Входные и выходные данные.

6. Можно ли изменять стандартный набор разделов (объединять их или добавлять новые)?

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

7. Что именно должно быть отражено в обязательном разделе «Назначение программы»?

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

8. Каково содержание разделов «Условия применения» и «Описание задачи»?

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

9. Что описывается в разделе «Входные и выходные данные»?

Ответ: Здесь подробно расписывается, какие данные программа принимает на вход, как они устроены, и в каком виде выдает результаты работы.

10. Какую практическую роль играет документ «Общее описание» в жизненном жизненном цикле программного изделия?

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