6.11. Требования к оформлению программной документации

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

Алгоритм – точное предписание исполнителю совеpшить определенную последовательность действий для достижения поставленной цели за конечное число шагов.

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

Программы подразделяют на следующие виды:

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

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

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

Программное обеспечение (ПО) – совокупность программ системы обработки информации и программных документов, необходимых для их эксплуатации.

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

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

Различают следующие типы программных модулей:

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

• пользовательские модули, предназначенные для упрощения работы программистов.

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

В пояснительной записке к дипломному проекту (работе) рекомендуется приводить следующие виды программных документов:

• описание применения;

• описание программы;

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

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

• руководство оператора;

• текст программы.

Примечание: описание применения и руководства системного программиста, программиста и оператора являются эксплуатационными программными документами.

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

Текст документа включает следующие части:

• назначение программы;

• условия применения;

• описание задачи;

• входные и выходные данные.

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

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

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

В части «Описание задачи» должны быть указаны определения задачи и методы ее решения.

В части «Входные и выходные данные» нужно указать сведения о входных и выходных данных.