3.3. Правила документирования и оформления работ.

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

Структура отчета может быть следующая:

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

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

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

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

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

3. Теоретическая часть. В ней описываются методы, положенные в основу решения задачи.

4. Входные данные. Приводится общая характеристика всех входных данных задачи с указанием назначения данных, типа, формата, размера и т.д.

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

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

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

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

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

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