Описание программы (пример)#
Серия: ГОСТ 19
ГОСТ: Номер ГОСТ
Код вида документа: 13
Пример децимального номера:
Пользователи документа:
Назначение документа из ГОСТ: Сведения о логической структуре и функционировании программы.
Пояснение:
Шаблон документа: “Формуляр” по ГОСТ 19
Структура и содержание документа#
Составление информационной части (аннотации и содержания) является обязательным.
Содержание#
Аннотация#
Общие сведения#
Обозначение и наименование программы#
Программное обеспечение, необходимое для функционирования программы#
Языки программирования, на которых написана программа#
Функциональное назначение#
В разделе “Функциональное назначение” нужно описать, какие задачи программа решает и для чего она используется. Также нужно указать какие-либо ограничения в использовании программы.
Например, если рассматривать программу для редактирования фотографий, то “Функциональное назначение” может быть описано следующим образом:
Note
Функциональное назначение
Программа “PhotoEdit Pro” предназначена для редактирования цифровых фотографий. Она предоставляет пользователю инструменты и функции для коррекции цветов, обрезки изображения, добавления текста и эффектов, ретуши мелких дефектов и многого другого. Программа может использоваться как профессионалами в области дизайна и фотографии, так и обычными пользователями для улучшения и изменения своих фотографий.
Функциональные ограничения
Программа предназначена исключительно для работы с цифровыми фотографиями и не поддерживает редактирование других типов изображений.
Возможности программы ограничены функциями, связанными с редактированием и обработкой изображений, и она не предоставляет функции создания векторной графики.
Программа может обрабатывать изображения только в форматах JPEG, PNG и TIFF.
Описание логической структуры#
Алгоритм программы#
Используемые методы#
Пример описания раздела “Используемые методы” может быть представлен в таком виде:
Note
Программа использует следующие методы:
getInput(): Этот метод запрашивает у пользователя ввод двух чисел и возвращает их в виде числовых значений.add(a, b): Метод принимает два числа в качестве аргументов и возвращает их сумму.displayResult(result): Этот метод выводит результат операции на экран.
Структура программы с описанием функций составных частей и связи между ними#
Note
Программа состоит из следующих функций:
main(): Основная функция программы. ВызываетgetInput(), затемadd(a, b)и, наконец,displayResult(result)для вывода результата на экран.getInput(): Запрашивает у пользователя ввод двух чисел, преобразует их в числовой формат и возвращает кортеж из двух чисел.add(a, b): Принимает два числа и возвращает их сумму.displayResult(result): Выводит результат операции на экран.
Note
Пример UML-диаграммы компонентов программы, а также связи между ними.
![@startuml
!define AUTH color DarkSeaGreen
!define PRODUCT color LightSkyBlue
!define CART color LightSalmon
!define NOTIFICATION color Gold
package "CloudMarketApp" {
[Client] as client
package "Microservices" {
[Auth Service] as auth
[Product Service] as product
[Cart Service] as cart
[Notification Service] as notification
}
[Database] as db
client --> auth : HTTP
client --> product : HTTP
client --> cart : HTTP
cart --> product : HTTP
cart --> auth : HTTP
cart --> notification : HTTP
notification --> cart : HTTP
auth --> db : JDBC
product --> db : JDBC
cart --> db : JDBC
}
@enduml](../../../../_images/plantuml-d5668b9e14355344f0ed7c82a523d14c355ccf2c.png)
Связи программы с другими программами#
Note
Данная программа является автономной и не имеет прямых связей с другими программами. Однако она может быть интегрирована в более крупные проекты как одна из составных частей.