Руководство по оформлению отчётов Gistup

Каждая лабораторная работа сдаётся в виде отчёта gistup — GitHub Gist в формате Markdown. Данное руководство описывает формат, структуру и правила оформления.

1. Что такое Gist

GitHub Gist — сервис для хранения фрагментов кода и заметок. Каждый Gist — мини-репозиторий с версионированием.

Public Gist — виден всем, индексируется поисковиками
Secret Gist — доступен только по прямой ссылке (не приватный, а скрытый)

Для отчётов используем Secret Gist — отправляете ссылку преподавателю.

2. Создание Gist

Через веб-интерфейс

2.1. Перейдите на gist.github.com
2.2. Имя файла: lab01_report.md (номер лабораторной)
2.3. Напишите отчёт в формате Markdown
2.4. Нажмите Create secret gist

Через GitHub CLI

# Создание из файла
$ gh gist create lab01_report.md --desc "Lab 01: Git SCM" --public

# Создание из stdin
$ cat report.md | gh gist create --filename lab01_report.md --desc "Lab 01"

# Редактирование существующего
$ gh gist edit <GIST_ID>

# Просмотр своих гистов
$ gh gist list

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

# Лабораторная работа №X — Название

**Автор:** Фамилия Имя
**Группа:** ХХХХ-ХХ-ХХ
**Дата:** ГГГГ-ММ-ДД

***

## Цель работы

Краткое описание цели лабораторной работы (1-2 предложения).

***

## Ход выполнения

### Шаг 1. Название шага

Описание что было сделано и зачем.

Команда: блок кода с указанием языка (` ```bash `)

Вывод: блок кода без языка (` ``` `)

Пояснение: что означает вывод, какие флаги использованы и почему.

### Шаг 2. ...

***

## Результаты

- Что было достигнуто
- Какие инструменты использованы
- Какие проблемы возникли и как решены

***

## Выводы

Краткие выводы по работе (3-5 предложений).

4. Правила оформления

Команды и вывод

Каждая команда в отчёте должна содержать:

Саму команду в блоке ```bash
Вывод в блоке ``` (без подсветки)
Пояснение: что делает команда, что означают флаги, что показывает вывод

# Пример правильного оформления
$ nmap -sV -p 22,80,443 192.168.1.1

Starting Nmap 7.94 ( https://nmap.org )
PORT    STATE SERVICE VERSION
22/tcp  open  ssh     OpenSSH 8.9p1
80/tcp  open  http    nginx 1.18.0
443/tcp open  https   nginx 1.18.0

Флаг -sV определяет версии сервисов на открытых портах. -p 22,80,443 сканирует только указанные порты. Результат: на хосте запущены SSH (OpenSSH 8.9) и веб-сервер nginx 1.18.0.

Что НЕ делать

Скриншоты вместо текста — запрещено (исключение: GUI-инструменты где текст невозможен)
Команды без пояснений — каждый флаг должен быть описан
Копипаст без понимания — преподаватель задаёт вопросы по отчёту