Оформление отчётной документация. Часть #1: отчёты по лабораторным работам

Введение

Этой статьёй я начну цикл публикаций о том, как готовить различную муторную и макулатурную работу, а именно как писать и оформлять различные отчёты, коих за период обучения скапливается множество, а переоформлять их из-за «неверного оформления» приходится многократно.

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

Итак, начну:


1 Структура отчёта и его содержимое

1.1 Титульный лист

В титульном лист обычно выдаётся преподавателем или кафедрой, но если данный шаблон отсутствует, то:

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

в) в центре написать номер лабораторной работы, дисциплину, название лабораторной работы, например:

«Отчет

по лабораторной работе №*номер лабораторной работы*

дисциплины «*название дисциплины*»

*название лабораторной работы*»;


г) ниже заголовка с выравниванием по правому краю листа или же небольшой табличкой включить нижеследующие данные:

«Выполнил(-а, -и):

студент(ы) гр. *вставить номер группы*

Ф.И.О.

Принял(-а):

преподаватель/*научная степень* каф. *сокращенное название кафедры*

Ф.И.О.»;

д) внизу по центру титульного листа написать: *город ВУЗа* — *год сдачи отчёта*.

Всегда должен быть на отдельном листе.


1.2 Содержание

Данный лист является необязательным для отчёта по лабораторным работам, создаётся только по требованию преподавателя.

Всегда должен быть на отдельном листе.


1.3 Цель работы

Обычно цель работы копируется из методички.

Иногда, по требованию преподавателя, формулируется самостоятельно.


1.4 Задачи

Данный пункт является необязательным для отчёта по лабораторным работам, создаётся только по требованию преподавателя.

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


1.5 Теоретические сведения (введение)

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

Иногда здесь присутствует описание алгоритма, используемого в лабораторной работе.

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


1.6 Ход работы

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

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


1.7 Описание программного обеспечения (руководство программиста)


1.8 Структурная схема программы / Блок-схема

Раздел обязателен, если Вы реализовываете ПО.

Здесь описывается то, как реализован заданный алгоритм, показывается и объясняется структурная схема работы программы (алгоритма программы) или же его блок-схема.

Может разделяться на два раздела.

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

Раздел обязателен, если Вы реализовываете ПО.

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

Это справочный раздел для пользователя.


1.10 Вывод / Заключение

Наиболее простой способ оформления данного раздела — скопировать и слегка переформулировать разделы «Цели» и/или «Задачи», например: "В данной лабораторной работе мы *«Цели» и/или «Задачи»*".

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


1.11 Список использованной литературы

Данный лист является необязательным для отчёта по лабораторным работам, создаётся только по требованию преподавателя по заданным ГОСТам или требованиям.

Всегда должен быть на отдельном листе.


1.12 Приложения

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

Всегда должен начинаться с новой страницы.


2 Оформление текста отчета

2.1 Изложение текста

Текст должен излагаться беспристрастно, от третьего лица.

Стиль изложения: научный.

Использовать только общепринятые сокращения.

Абзац должен начинаться с красной строки, желательны переносы, текст должен размещаться по ширине.

См. список рекомендованной литературы.


2.2 Оформление ссылок, подписей к таблицам, рисункам, блок-схемам, листингам и т.п.

Подписи к рисункам размещаются под изображением и оформляются с использованием сквозной нумерации «Рис./Рисунок *порядковый номер рисунка в отчёте или в разделе*» и подписи, излагающей содержание рисунка, например: «Рис. 1. Интерфейс работы программы» или же «Рис. 1.1. Интерфейс работы программы».

Подписи к таблицам оформляются таким образом: над таблицей пишется порядковый номер таблицы в отчёте и название таблицы (например: «Таблица 1. Статическое распределение возрастных характеристик при использовании сети Интернет»), если таблица продолжается на следующем листе, то её продолжают так: «Продолжение таблицы 1. Статическое распределение возрастных характеристик при использовании сети Интернет».

Подписи блок-схемам располагаются под блок-схемами, а к листингам - над ними.

Для ссылки на какой либо раздел, рисунок, таблицу и т.п. пишут слово «см.» и *тип ссылки и порядковый номер*, например: «см. рис. 1».


2.3 Блок-схемы

Блок-схемы оформляются в соответствии с ГОСТ 19.701-90 и разумом (ибо он устарел).


2.4 Списки

Списки оформляются либо русскими буквами, либо арабскими цифрами. Если в один список вложен другой, то один оформляется русскими буквами, а другой — арабскими цифрами.


2.5 Нумерация страниц

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


2.6 Нумерация разделов

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

Раздел «Приложения» и его приложения нумеруются арабскими цифрами или русскими буквами (буква «ё» не используется). При этом каждый подраздел должен иметь своё название. Также, каждый раздел может иметь отдельный титульный лист.

Пример: «Приложение А (обязательное). Блок-схема работы алгоритма».


Заключение

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


Список рекомендуемой литературы

ЕСПД (ЕДИНАЯ СИСТЕМА ПРОГРАММНОЙ ДОКУМЕНТАЦИИ)

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


а) ГОСТ 19.701-90 (ИСО 5807-85). СХЕМЫ АЛГОРИТМОВ, ПРОГРАММ, ДАННЫХ И СИСТЕМ

Морально устарел, но ещё не был заменён на другой ГОСТ и применим в адаптации, к современным ПО.

Думается, в дальнейшем, найти ИСО, которым был заменён ИСО 5807-85, лёгший в основу ГОСТ 19.701-90, и перевести его.


б) ГОСТ 2.106-96. Текстовые документы

Рассказывает о том, как оформлять текстовую часть документации.