Оформление отчёта.
Пост о том, как оформлять отчёт.
Введение
В статье мы рассмотрим следующие темы:
- Какая информация должна быть в отчёте?
- Что такое Markdown и почему его используют для оформления отчёта?
- Техническая часть оформления отчёта.
Какая информация должна быть в отчёте?
Отчёт обычно состоит из следующих частей:
- Цель работы.
Здесь приводится формулировка цели лабораторной работы. Формулировки цели для каждой лабораторной работы приведены в методических указаниях.
- Формулировка задания.
Здесь приводится описание задания в соответствии с рекомендациями методического пособия и выданным вариантом.
- Теоретическое введение.
Здесь описываются теоретические аспекты, связанные с выполнением работы.
- Выполнение работы.
Описываются проведённые действия, в качестве иллюстрации даётся ссылка на иллюстрацию
- Выводы.
Здесь кратко описываются итоги проделанной работы.
Что такое markdown и почему его используют для оформления отчёта?
Markdown — язык текстовой разметки, созданный писателем и блогером Джоном Грубером. Он предназначен для создания красиво оформленных текстов в обычных файлах формата TXT. Вам не нужны громоздкие процессоры вроде Word или Pages, чтобы создавать документы с жирным или курсивным начертанием, цитатами, ссылками и даже таблицами. Достаточно запомнить простые правила Markdown, и можно писать хоть в «Блокноте».
Этот язык разметки используется блогерами, писателями, редакторами и журналистами по всему миру. И используется он не просто так, а в связи с тем, что можно использовать определённый шаблон, что упрощает редактирование и оформление работы. Этот язык очень удобен для создания множества однотипных отчётов, так как можно взять подходящий шаблон и просто каждый раз вносить необходимые изменения, не думая при этом о размере шрифта, отступах, формировании списка литературы, списка иллюстраций, ведь всё это уже автоматически задано.
Техническая часть оформления отчёта.
В этой части рассмотрим процесс подготовки отчёта с помощью Markdown.
Для начало нужно загрузить или создать подходящий вам шаблон. Затем просто в необходимые поля внести информацию. Кроме отчёта необходимо завести отдельные папки для файла с источниками литературы и с картинками. Для того чтобы вставить картинку нужно прописать к ней путь используя форму:
{ #fig:001 width=70% }
Для офрмления файла со списком литературы также существуют шаблоны, в них также в необходимые поля стоит внести информаци о названии книги/электронного истчоника, об авторе, годе издания, издателе и остальную необходимую для вас. Расставив по тексту ссылки такого вида @tannenbaum:modern-os:ru]
и скомпилировав, у вас появится сформированный список литературы.
Также Markdown имеет и другие возможности, например создание таблиц, оформление формул и кода. Всё это можно узнать, почитав информацию, например, на данном сайте
Выводы
Отчёт - это структурированное изложение целей, процесса и результатов про какой-то проделанной работе. Он помогает человеку лучше понять ваши действия и легко ориентироваться в проделанной работе. Markdown - удобный и простой в использовании легковесный язык разметки, отлично подходящий для оформления отчётов. Создание отчётов очень полезный навык, который стоит освоить и использовать.