5.6 Руководство программиста

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

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

• структура программы;

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

• описание программы/модулей;

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

При необходимости также разрабатывают вопросы:

• проверка программы;

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

• дополнительные возможности;

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

• сообщения программисту.

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

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

5.7 Руководство пользователя

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

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

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

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

• описание интерфейса.

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

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

• реакция программы на действия, выполняемые пользователем с компонентами окна.

• список правильных действий;

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

• сообщения пользователю.

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

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

5.8 Заключение

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

Объем заключения должен составлять 1-2 страницы.

5.9 Список литературы

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

5.10 Приложения

5.10.1 Текст программы

Требования к оформлению исходного текста программы.

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

• Осмысленные названия – все типы и структуры данных, переменные, подпрограммы должны иметь название в соответствии с выполняемой функцией;

• Структурирование текста программы (отступы, разделители, заголовки и т.д.);

• Комментарии:

• Комментарии модуля/программы:

• Сведения об авторе (группа, ФИО, дата);

• Назначение и результат выполнения;

• Указания по использованию модуля;

• Список и назначение основных переменных;

• Список используемых подпрограмм;

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

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

• Комментарий процедуры. (Назначение, входные/ выходные параметры, результат);

• Указание наименования системных функций и возвращаемых ими значений;

• Указание прикладного назначения и пояснение структур данных.

Рекомендуется придерживаться правила комментирования программы в соотношении 2:1 (инструкции : комментарий), обеспечивающего, в среднем, хорошую читаемость программы.