Отчёт по практике — различия между версиями

Материал из Персональная wiki Зайцевой Анастасии Владленовны
Перейти к: навигация, поиск
(Требования к оформлению: Листинги)
(Про стиль и про структуру.)
Строка 1: Строка 1:
 
== Требования к содержанию ==
 
== Требования к содержанию ==
 +
 +
=== Самое главное ===
  
 
[[Задание на практику]] должно соответствовать специальности.
 
[[Задание на практику]] должно соответствовать специальности.
Строка 5: Строка 7:
 
Содержательная часть отчёта должна соответствовать заданию.
 
Содержательная часть отчёта должна соответствовать заданию.
  
Отчёт должен быть написан грамотным языком, без откровенных ляпов вроде «теор<span style="color:#FF00CC;">'''и'''</span>тическая часть» (проверочное слово{{·}}— теор<span style="color:green;">'''е'''</span>тик) и «подъезжая к{{·}}станции, с{{·}}меня слетела шляпа».
+
Отчёт должен быть написан '''грамотным языком''', без откровенных ляпов вроде «теор<span class="wrong">'''и'''</span>тическая часть» (проверочное слово{{·}}— теор<span class="correct">'''е'''</span>тик) и «подъезжая к{{·}}станции, с{{·}}меня слетела шляпа».
  
Избегайте сленга в{{·}}тех случаях, когда имеется адекватный русский аналог: не{{·}}«рандомный», а «случайный»; не{{·}}«юзер», а «пользователь»; не{{·}}«железо», а «комплектующие» или «аппаратная часть».
+
Придерживайтесь '''научного стиля''':
 +
* Избегайте сленга в{{·}}тех случаях, когда имеется адекватный русский аналог: не{{·}}«рандомный», а «случайный»; не{{·}}«юзер», а «пользователь»; не{{·}}«железо», а «комплектующие» или «аппаратная часть». Только не{{·}}переусердствуйте с{{·}}канцеляритом: «хард» и «винт»{{·}}— это всё-таки «жёсткий диск», а не{{·}}«накопитель на{{·}}жёстких магнитных дисках».
 +
* Забудьте о{{·}}риторических вопросах, эмоциях, словах-паразитах. Это отчёт о{{·}}научной работе, а '''не{{·}}статья для Хабра'''.
 +
** <span class="wrong">Неправильно:</span> «''А что{{·}}же делать, если софтина выдала ошибку XYZ? Без паники! Наверное, вы просто-напросто не{{·}}успели поставить патч KB100500. И как это проверить? А вот как…''»
 +
** <span class="correct">Правильно:</span> «''После запуска программа может выдать ошибку XYZ. Как правило, это связано с{{·}}отсутствием обновления KB100500. Для проверки необходимо выполнить следующие действия…''»
 +
* Не{{·}}обращайтесь напрямую к{{·}}читателю («вы можете», «ваш компьютер» и т.{{·}}п.) — см. выше.
 +
* Не{{·}}употребляйте местоимения первого лица единственного числа: не{{·}}«я изучил», а «были изучены», не{{·}}«моя работа», а «данная работа».
  
 
=== Структура отчёта ===
 
=== Структура отчёта ===
Строка 13: Строка 21:
 
* [[Отчёт по практике/Титульный лист|Титульный лист]]
 
* [[Отчёт по практике/Титульный лист|Титульный лист]]
 
* [[Отчёт по практике/Индивидуальное задание|Индивидуальное задание]]
 
* [[Отчёт по практике/Индивидуальное задание|Индивидуальное задание]]
* Оглавление
+
* <span style="text-transform: uppercase;">Оглавление</span> (или <span style="text-transform: uppercase;">Содержание</span>)
* Введение
+
* <span style="text-transform: uppercase;">Введение</span>
* Основная часть
+
* <span style="text-transform: uppercase;">Основная часть</span>
** 1. Характеристика организации (то есть краткое описание базы практики)
+
** 1 Характеристика организации (то есть краткое описание базы практики)
** 2. ''(выполнение задания)''
+
** 2, 3 и т.{{·}}д., можно с{{·}}подразделами (2.1, 2.2…) — собственно выполнение задания
* Заключение
+
* <span style="text-transform: uppercase;">Заключение</span>
* Список использованных источников
+
* <span style="text-transform: uppercase;">Список использованных источников</span>
  
 
Всё вышеперечисленное '''обязательно'''.
 
Всё вышеперечисленное '''обязательно'''.
  
Опциональные элементы: реферат (обзор), термины и определения, используемые сокращения, приложения.
+
Опциональные элементы: реферат (обзор), термины и определения, используемые сокращения, приложения — тоже на{{·}}верхнем уровне и тоже капслоком.
  
Нумеровать можно ''только'' разделы и подразделы основной части. Пожалуйста, настройте списки и стили заголовков соответствующим образом, чтобы введению и заключению не{{·}}присваивались номера.
+
Пожалуйста, следите за{{·}}логичностью структуры. Так, например, в{{·}}разделе не{{·}}может быть всего один подраздел: либо два и более, либо ни{{·}}одного.
  
 
=== Объём отчёта ===
 
=== Объём отчёта ===
  
Согласно [[ООПП]], от 10 до 30 страниц.
+
Согласно [[ООПП]], от 10 до 30 страниц. Не{{·}}критично, если их будет больше, особенно если превышение произошло за{{·}}счёт приложений: исходников, таблиц.
  
 
== Требования к оформлению ==
 
== Требования к оформлению ==
Строка 44: Строка 52:
 
* '''Выравнивание текста''' — по{{·}}ширине.
 
* '''Выравнивание текста''' — по{{·}}ширине.
  
Мы, конечно, не{{·}}будем вымерять всё с{{·}}линейкой. Если интервал{{·}}— не{{·}}1.5, а 1.4, вряд{{·}}ли кто-то обратит внимание. Но если интервал одинарный, если шрифт{{·}}— Comic Sans, если правый край текста «рваный» (нет выравнивания по{{·}}ширине), если левое поле такое маленькое, что переплёт закрывает буквы,{{·}}— тогда заставим переделывать, потому что всё перечисленное сильно ухудшает читабельность текста и общее впечатление об{{·}}отчёте (и его авторе).
+
Мы, конечно, не{{·}}будем вымерять всё с{{·}}линейкой. Если интервал{{·}}— не{{·}}1.5, а 1.4, вряд{{·}}ли кто-то обратит внимание. Если вы набирали отчёт не{{·}}в{{·}}MS{{·}}Word и вообще не{{·}}в{{·}}Windows и там по{{·}}умолчанию используется другой шрифт с{{·}}засечками — не{{·}}страшно. Но если интервал одинарный, если шрифт{{·}}— Comic Sans, если правый край текста «рваный» (нет выравнивания по{{·}}ширине), если левое поле такое маленькое, что переплёт закрывает буквы,{{·}}— тогда заставим переделывать, потому что всё перечисленное сильно ухудшает читабельность текста и общее впечатление об{{·}}отчёте (и его авторе).
  
 
Электронную версию отчёта нужно предоставлять в{{·}}формате '''PDF'''.
 
Электронную версию отчёта нужно предоставлять в{{·}}формате '''PDF'''.
  
 
Шаблон отчёта по{{·}}летней практике, в{{·}}котором стили (за{{·}}исключением нумерации заголовков) уже заданы как надо: <span style="font-size: 4em; font-weight: bold;">[http://seizewa.ru/practice/Shablon_otchyota.dotx]</span>
 
Шаблон отчёта по{{·}}летней практике, в{{·}}котором стили (за{{·}}исключением нумерации заголовков) уже заданы как надо: <span style="font-size: 4em; font-weight: bold;">[http://seizewa.ru/practice/Shablon_otchyota.dotx]</span>
 +
 +
=== Нумерация страниц ===
 +
 +
На{{·}}титульном листе и индивидуальном задании '''номер страницы не{{·}}ставится''', но он есть: 1 и 2, соответственно.
 +
 +
Оглавление{{·}}— это страница 3.
 +
 +
И далее по{{·}}порядку.
 +
 +
Номер ставится посередине внизу или в{{·}}правом нижнем углу.
 +
 +
=== Заголовки ===
 +
 +
Нумеровать можно ''только'' разделы и подразделы основной части. Пожалуйста, настройте списки и стили заголовков соответствующим образом, чтобы введению и заключению не{{·}}присваивались номера.
 +
 +
Верхний уровень (тот, где введение){{·}}— капслоком.
 +
 +
Точки после номеров не{{·}}ставятся, то есть не «1.{{·}}Характеристика организации», а «1{{·}}Характеристика организации» (через пробел, табуляцию, неразрывный пробел{{·}}— смотря как настроить).
 +
 +
В{{·}}конце заголовка точка не{{·}}ставится.
 +
 +
В{{·}}оглавление попадает всё, что '''после''' оглавления, то есть перечень сокращений, введение и т.{{·}}д., включая приложения.
  
 
=== Формулы, рисунки, таблицы ===
 
=== Формулы, рисунки, таблицы ===
Строка 75: Строка 105:
 
На{{·}}каждый источник должна быть хотя{{·}}бы одна '''ссылка''' из{{·}}текста отчёта в{{·}}виде номера в{{·}}квадратных скобках, см., например, [http://www.lib.tsu.ru/win/produkzija/metodichka/6_4.html].
 
На{{·}}каждый источник должна быть хотя{{·}}бы одна '''ссылка''' из{{·}}текста отчёта в{{·}}виде номера в{{·}}квадратных скобках, см., например, [http://www.lib.tsu.ru/win/produkzija/metodichka/6_4.html].
  
=== Нумерация страниц ===
+
Список упорядочивается '''в{{·}}порядке первого упоминания'''. То{{·}}есть в{{·}}тексте отчёта встретится сначала [1], потом [2], потом, допустим, [3–5], а потом можно опять [2]. Если сначала ссылка [5], потом [2], потом [1, 3, 4]{{·}}— это неправильно.
 
+
На{{·}}титульном листе и индивидуальном задании '''номер страницы не{{·}}ставится''', но он есть: 1 и 2, соответственно.
+
 
+
Оглавление{{·}}— это страница 3.
+
 
+
И далее по{{·}}порядку.
+
 
+
Номер ставится посередине внизу или в{{·}}правом нижнем углу.
+
  
 
=== Прошивка ===
 
=== Прошивка ===

Версия 18:02, 25 ноября 2019

Требования к содержанию

Самое главное

Задание на практику должно соответствовать специальности.

Содержательная часть отчёта должна соответствовать заданию.

Отчёт должен быть написан грамотным языком, без откровенных ляпов вроде «теоритическая часть» (проверочное слово — теоретик) и «подъезжая к станции, с меня слетела шляпа».

Придерживайтесь научного стиля:

  • Избегайте сленга в тех случаях, когда имеется адекватный русский аналог: не «рандомный», а «случайный»; не «юзер», а «пользователь»; не «железо», а «комплектующие» или «аппаратная часть». Только не переусердствуйте с канцеляритом: «хард» и «винт» — это всё-таки «жёсткий диск», а не «накопитель на жёстких магнитных дисках».
  • Забудьте о риторических вопросах, эмоциях, словах-паразитах. Это отчёт о научной работе, а не статья для Хабра.
    • Неправильно: «А что же делать, если софтина выдала ошибку XYZ? Без паники! Наверное, вы просто-напросто не успели поставить патч KB100500. И как это проверить? А вот как…»
    • Правильно: «После запуска программа может выдать ошибку XYZ. Как правило, это связано с отсутствием обновления KB100500. Для проверки необходимо выполнить следующие действия…»
  • Не обращайтесь напрямую к читателю («вы можете», «ваш компьютер» и т. п.) — см. выше.
  • Не употребляйте местоимения первого лица единственного числа: не «я изучил», а «были изучены», не «моя работа», а «данная работа».

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

  • Титульный лист
  • Индивидуальное задание
  • Оглавление (или Содержание)
  • Введение
  • Основная часть
    • 1 Характеристика организации (то есть краткое описание базы практики)
    • 2, 3 и т. д., можно с подразделами (2.1, 2.2…) — собственно выполнение задания
  • Заключение
  • Список использованных источников

Всё вышеперечисленное обязательно.

Опциональные элементы: реферат (обзор), термины и определения, используемые сокращения, приложения — тоже на верхнем уровне и тоже капслоком.

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

Объём отчёта

Согласно ООПП, от 10 до 30 страниц. Не критично, если их будет больше, особенно если превышение произошло за счёт приложений: исходников, таблиц.

Требования к оформлению

Формат документа

При оформлении отчёта по практике необходимо соблюдать следующие формальности:

  • Бумага — A4, односторонняя печать.
  • Шрифт — Times New Roman 14pt.
  • Интервал — полуторный.
  • Поля — верхнее 20 мм, нижнее 20 мм, левое 30 мм, правое 10 мм.
  • Абзацный отступ (красная строка) — 1.25 см.
  • Выравнивание текста — по ширине.

Мы, конечно, не будем вымерять всё с линейкой. Если интервал — не 1.5, а 1.4, вряд ли кто-то обратит внимание. Если вы набирали отчёт не в MS Word и вообще не в Windows и там по умолчанию используется другой шрифт с засечками — не страшно. Но если интервал одинарный, если шрифт — Comic Sans, если правый край текста «рваный» (нет выравнивания по ширине), если левое поле такое маленькое, что переплёт закрывает буквы, — тогда заставим переделывать, потому что всё перечисленное сильно ухудшает читабельность текста и общее впечатление об отчёте (и его авторе).

Электронную версию отчёта нужно предоставлять в формате PDF.

Шаблон отчёта по летней практике, в котором стили (за исключением нумерации заголовков) уже заданы как надо: [1]

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

На титульном листе и индивидуальном задании номер страницы не ставится, но он есть: 1 и 2, соответственно.

Оглавление — это страница 3.

И далее по порядку.

Номер ставится посередине внизу или в правом нижнем углу.

Заголовки

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

Верхний уровень (тот, где введение) — капслоком.

Точки после номеров не ставятся, то есть не «1. Характеристика организации», а «1 Характеристика организации» (через пробел, табуляцию, неразрывный пробел — смотря как настроить).

В конце заголовка точка не ставится.

В оглавление попадает всё, что после оглавления, то есть перечень сокращений, введение и т. д., включая приложения.

Формулы, рисунки, таблицы

Формулы нумеруем (справа), рисунки нумеруем и указываем название (внизу), таблицы нумеруем и указываем название (сверху).

На каждый объект с номером должна быть хотя бы одна ссылка из текста отчёта — иначе, спрашивается, зачем его вообще включать в отчёт?

В целом руководствуйтесь ГОСТ 7.32 «Отчёт о научно-исследовательской работе».

Листинги

Куски кода, логи, содержимое INI-файлов и прочие стены технического текста не должны болтаться в отчёте просто так.

Небольшие фрагменты оформляем так, словно это скриншот из Блокнота или консоли: моноширинный шрифт (Courier New, Consolas, Liberation Mono и т. п.), без выравнивания по ширине, можно обвести рамочкой. Подписываем как рисунок. Ссылаемся из текста: «На рисунке N представлен код функции…».
По-настоящему скриншотить не нужно: пикселизованные буквы будут плохо выглядеть при печати.

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

Список использованных источников

Он должен быть.

Он должен быть оформлен как положено. Если ссылаетесь на электронную версию статьи — простого URL недостаточно, нужно указать и название, и то, что это электронный ресурс, и дату обращения… Поищите примеры в Гугле.

На каждый источник должна быть хотя бы одна ссылка из текста отчёта в виде номера в квадратных скобках, см., например, [2].

Список упорядочивается в порядке первого упоминания. То есть в тексте отчёта встретится сначала [1], потом [2], потом, допустим, [3–5], а потом можно опять [2]. Если сначала ссылка [5], потом [2], потом [1, 3, 4] — это неправильно.

Прошивка

Листы отчёта обязательно должен быть скреплены. Не скрепкой, а так, чтобы листать было удобно.

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

Подробнее — см. Скрепление отчёта.