Оформление отчетов

Threat Hunt
Cyber Threat Intelligence
Техническая аналитика
R
Tidyverse
Author

i2z1@yandex.ru

Published

October 20, 2021

Методические рекомендации к оформлению отчетов по практическим и лабораторным работам

Общие требования

  1. Результаты практических и лабораторных работ выполняются в электронном виде с с использованием сервиса Gitlab.
  2. Репозиторий должен быть либо публично доступным, либо закрытым, но с обеспечением доступа к нему на чтение и создание issues пользователя преподавателя i2z1
  3. Конечный результат, который представляется на проверку должен находиться на ветке main или master

Структура

  1. Структура репозитория представлена здесь
  2. Отчет оформляется с использованием языка разметки Markdown или Rmarkdown
  3. Сам отчет должен находиться в папке лабораторной или практической работы и называться README.md в случае использования Markdown и README.Rmd в случае использования Rmarkdown соответственно.
Tip

Если Вы идете #в-ногу-со-временем-и-даже-over-the-edge, можете использовать формат Quarto

Хорошо структурированный и оформленный отчет подчеркивает уровень выполненной работы, глубину детальной проработки темы Автором и свободу владения и инструментами и материалом!

Обратите внимание!

В markdown:

  • может быть только 1 заголовок первого уровня (символ #)
  • Каждый элемент отделяется от другого, как минимум, 1 пустой строкой
# Один единственный заголовок первого уровня

## Заголовок 1

Текст 1
Текст 1
Текст 1

## Заголовок 2

Текст 2
Текст 2
Текст 2
  • программный код выделяется одним или тремя апострофами “`” (часто, клавиша ё в английской раскладке) – пример на Github