Составление отчётной документации по решённым задачам алгоритмизации и программирования

 

МИНИСТЕРСТВО ТРАНСПОРТА РОССИЙСКОЙ 

ФЕДЕРАЦИИ 

ФЕДЕРАЛЬНОЕ ГОСУДАРСТВЕННОЕ БЮДЖЕТНОЕ 

ОБРАЗОВАТЕЛЬНОЕ УЧРЕЖДЕНИЕ ВЫСШЕГО 

ОБРАЗОВАНИЯ 

«РОССИЙСКИЙ УНИВЕРСИТЕТ 

ТРАНСПОРТА (МИИТ)» 

ИНСТИТУТ ТРАНСПОРТНОЙ ТЕХНИКИ И СИСТЕМ 

УПРАВЛЕНИЯ (ИТТСУ) 

Кафедра «Управление и защита информации» 

 

А.И. САФРОНОВ, Н.Н. ЗОЛЬНИКОВА, В.Г. НОВИКОВ  

СОСТАВЛЕНИЕ ОТЧЁТНОЙ ДОКУМЕНТАЦИИ ПО РЕШЁННЫМ 

ЗАДАЧАМ АЛГОРИТМИЗАЦИИ И ПРОГРАММИРОВАНИЯ 

 

Учебно-методическое пособие  

для проведения аудиторных занятий по Учебной практике 

 

 

МОСКВА – 2018 

 
 

 

 

МИНИСТЕРСТВО ТРАНСПОРТА РОССИЙСКОЙ ФЕДЕРАЦИИ 

ФЕДЕРАЛЬНОЕ ГОСУДАРСТВЕННОЕ БЮДЖЕТНОЕ 

ОБРАЗОВАТЕЛЬНОЕ УЧРЕЖДЕНИЕ ВЫСШЕГО ОБРАЗОВАНИЯ 

«РОССИЙСКИЙ УНИВЕРСИТЕТ 

ТРАНСПОРТА (МИИТ)» 

ИНСТИТУТ ТРАНСПОРТНОЙ ТЕХНИКИ И СИСТЕМ 

УПРАВЛЕНИЯ (ИТТСУ) 

Кафедра «Управление и защита информации» 

 

 
 
 

А.И. САФРОНОВ, Н.Н. ЗОЛЬНИКОВА, В.Г. НОВИКОВ 

  

СОСТАВЛЕНИЕ ОТЧЁТНОЙ ДОКУМЕНТАЦИИ ПО РЕШЁННЫМ 

ЗАДАЧАМ АЛГОРИТМИЗАЦИИ И ПРОГРАММИРОВАНИЯ 

 

 

Учебно-методическое пособие  

для бакалавров направления 

27.03.04  «Управление в технических системах» 

 

 

 

 

                                            МОСКВА – 2018 

 

 

 

УДК : 004 : 378 (075.6) 
 
С 21 

 
Сафронов 
А.И., 
Зольникова 
Н.Н., 
Новиков 
В.Г. 

Составление отчётной документации по решённым задачам 
алгоритмизации и программирования: Учебно-методическое 
пособие для проведения аудиторных занятий по Учебной 
практике. – М.: РУТ (МИИТ), 2018. – 83 с. 

 
 
В учебно-методическом пособии рассмотрены основные 

идеи и принципы составления отчётной документации к 
решённым обучающимися РУТ (МИИТ) типовым задачам 
программирования и алгоритмизации. Материалы, собранные в 
учебно-методическом 
пособии, 
ориентированы 
на 

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

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

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

 
 
Рецензент: 
Доцент кафедры «Радиофизика, антенны и микроволновая 

техника» Московского авиационного института (национального 
исследовательского университета), к.т.н. Ильин Е.В.  

 

© РУТ (МИИТ), 2018

 

Введение 

Работы, выдаваемые преподавателями студентам вузов, 

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

На 
страницах 
данного 
учебно-методического 
пособия 

рассматриваются основные идеи и принципы составления 
отчётной документации к решённым обучающимися РУТ 
(МИИТ) 
типовым 
задачам 
программирования 
и 

алгоритмизации.  

Издание нацелено на создание унифицированной методики 

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

«Управление и защита информации». 

В учебно-методическом пособии ставится конкретная задача 

по составлению отчётной документации с акцентом внимания 
на 
детализации 
существующих 
правил 
оформления, 
в 

частности, правил оформления титульного листа, оглавления и 
библиографического 
списка. 
Правила 
оформления 

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

учебно-методическом 
пособии 
задачи. 
Размещение 
столь 

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

Анализ работ, выполняемых обучающимися по различным 

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

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

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

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

Раздел, 
посвященный 
оформлению 
автособираемого 

библиографического 
списка, 
содержится 
в 
учебно-

методическом 
пособии 
исключительно 
как 
справочная 

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

Для контроля усвоения обучающимися материала им 

предлагается к выполнению самостоятельная разработка блок-
схем 
алгоритмов 
к 
фрагментам 
ранее 
составленного, 

отлаженного и работоспособного программного обеспечения, 

что позволяет им развить навыки анализа кода программного 
обеспечения, а также видение однозначного соответствия 
блоков схем алгоритмов использованным в коде операторам 
языка Visual C# [1, 2]. 

1  Задание 1 

Овладеть навыками составления отчётной документации на 

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

проанализировать составленный на языке Visual C# фрагмент 
кода; научиться составлению блок-схем алгоритмов программ в 
графическом 
редакторе 
схем 
Microsoft 
Office 
Visio 
по 

имеющемуся в наличии исходному коду.  

Представленная 
ниже 
методика 
позволяет 
приобрести 

навыки работы с инструментами разметки и форматирования, 
входящими в состав текстового редактора Microsoft Office Word.  

По итогам выполнения работы у обучающихся должен 

получиться шаблон типового отчёта о решённой задаче Учебной 
практики. Здесь следует обратить внимание на то, что задачи 
Учебной практики подразделяются на вычислительные задачи и 
задачи программирования, потому структура отчётов к каждому 
из упомянутых типов задач будет незначительно отличаться. 
Отчёт составляется в текстовом редакторе Microsoft Office Word. 

2  Цель работы 

В 
данном 
разделе 
приводится 
одна 
из 
возможных 

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

графического редактора для составления схем (в частности, 
блок-схем алгоритмов) Microsoft Office Visio, а также базовых 
функций 
текстового 
редактора 
Microsoft 
Office 
Word. 

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

3  Структура отчёта 

Отчёт по выполненной работе должен содержать следующие 

компоненты и разделы: 

1. Титульный лист. 

2. Оглавление (строго автособираемое). 

3. Формулировку цели работы. 

4. Описание задачи согласно выданному варианту. 

5. Содержательную часть: 

5.1. Анализ фрагмента кода с текстовым описанием 
выявленных его особенностей. 

5.2. Составление фрагмента блок-схемы алгоритма 
по фрагменту кода. 

6. Формулировку вывода о проделанной работе (вывод 
формулируется обезличено, то есть в нём должны 

отсутствовать местоимения, такие как: «я», «мы» и 
другие). 

Далее сформулирован перечень рекомендаций к отчёту, 

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

обучающимся, а также существенно упростить процедуру 
проверки преподавателем составленного отчёта: 

1. Выполнение дополнительных иллюстраций / рисунков / 
скриншотов для демонстрации действий по изменению 
разметки «до» / «после» («было» / «стало»). 

2. Подготовка нумерации иллюстраций / рисунков / 
скриншотов (если таковые имеются) с подписями, 
содержащими названия иллюстраций / рисунков / 
скриншотов, например, «Рисунок 1 – Набор стандартных 
фигур Microsoft Office Visio».  

Внимание! Отчёт по выполненной работе сдаётся в 

электронном виде и на бумажном носителе. Электронный вид, 
как правило, направляется на адрес электронной почты 
преподавателя. Такое письмо должно быть снабжено либо 
файлом архива (*.rar, *.zip), либо двумя отдельными файлами: с 
отчётом Microsoft Office Word (*.docx) и с составленной блок-
схемой алгоритма в Microsoft Office Visio (*.vsd, *.vsdx). 

4  Требования к именам файлов: 

Общий вид формата: «Дата. Задание. Фамилия.docx». 

Формат даты: «ГГГГММДД», где ГГГГ – четыре цифры 

текущего года, ММ – две цифры текущего месяца, ДД – две 
цифры текущего дня. 

Формат задания: «Задание NNk», где NN – две цифры номера 

задания, k – обозначение «о», если файл содержит общую часть, 
«и», если файл содержит индивидуальную часть, «ои», если 
файл содержит как общую, так и индивидуальную части. 

Если устранить замечания по работе обучающемуся удаётся 

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

Если изменение имён файлов нарушает корректную работу 

программы: 
допускается 
упаковка 
всей 
совокупности 

имеющихся в наличии файлов в архив «*.rar» или «*.zip» с 
именем, 
соответствующим 
формату 
«Дата. 
Задание. 

Фамилия.rar» 

Примеры правильных имён файлов, которые сдаются на 

проверку впервые:  

«20180520. Задание 01о. Иванов.vsdx»; 

«20180309. Задание 01ои. Иванов.docx»; 

Примеры правильных имён файлов, которые сдаются на 

проверку повторно в тот же день:  

«20180520. Задание 01о. Иванов (1).vsdx»; 

«20180309. Задание 01ои. Иванов (3).docx». 

5  Методика оформления титульного листа: 

Важно! Помните, что выбранное для титульного листа 

семейство шрифта (например, «Times New Roman») должно 
использоваться на протяжении всего документа. Семейство 

шрифта должно быть выбрано любое строгое на усмотрение 
обучающегося.  

К строгим семействам шрифтов относят: «Times New Roman», 

«Tahoma», «Verdana», «Calibri» и другие. К нестрогим 
семействам шрифтов: «Majestic», «Lucida», «Comic Sans MS», 
«Gill», «Decor», «Calligraph» и другие.  

Размер шрифта рекомендуется выбрать величиной в 16 

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

Титульный лист состоит из следующих разделов (Рисунок 

5.1): 

- ведомственная принадлежность вуза; 

- регалии вуза; 

- наименование вуза с указанием его сокращённого 
наименования; 

- наименование института (с указанием сокращённого 
наименования или без него); 

- наименование кафедры, к которой относится дисциплина 
(с указанием сокращённого наименования или без него); 

- вид документа; 

- вид работы (раздел присутствует не во всех документах); 

- наименование дисциплины;