Не следует забывать о том, что абсолютное большинство людей, которые будут знакомиться с вашей работой, ровным счётом ничего не знают о том, что вы в ней де лали, как вы это делали и какие получили результаты. Именно поэтому ни в пояснительной записке, ни на защите нельзя формулировать мысли так, как будто все уже в курсе, а вам нужно лишь пояснить пару мелких деталей.

3.7. ПРОГРАММНАЯ ДОКУМЕНТАЦИЯ

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

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

3.7.1. ОПИСАНИЕ ПРОГРАММЫ

Описание программы выполняется в соответствии с ГОСТ 19.402–78 и должно содержать:

1)общие сведения:

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

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

•языки программирования, на которых написана программа;

•используемые компиляторы;

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

3)описание логической структуры программы:

•структуру программы с описанием составных частей и связей между ними;

24

•схему программы по ГОСТ 19.701–90 и подробное словесное описание;

•используемые методы;

4)сведения об аппаратной платформе, на которой должна выпол-

няться программа;

5)сведения о месте хранения программы и порядке её запуска;

6)описание входных данных: формат, организация, способ кодирования, предварительная подготовка;

7)описание выходных данных: формат, организацию, способ хранения.

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

Описание подпрограммы должно включать:

1)название подпрограммы;

2)назначение подпрограммы;

3)объявление подпрограммы, как оно даётся в исходном тексте;

4)описание передаваемых подпрограмме аргументов;

5)описание возвращаемого подпрограммой значения;

6)блок-схему алгоритма подпрограммы;

7)подробное словесное описание работы подпрограммы.

3.7.2.ИСХОДНЫЕ ТЕКСТЫ

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

Текст каждого модуля должен начинаться с аннотации, в которой должны быть указаны:

•название модуля;

•назначение модуля;

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

•входные параметры;

•выходные параметры;

•данные об авторе;

•дата последней модификации;

•номер версии;

•история изменений.

25