Шаги в работе
Как провести участника по работе шаг за шагом — посередине страницы работы, с кнопками, подсказками и проверкой по репозиторию.
Шаги нужны там, где длинное задание человеку не по силам: первая настройка, установка, первый запуск. Страница работы становится уроком: сверху, прилипая, — сколько пройдено и этапы полосками по шагам; каждый этап — своя страница, у шага одно действие и одна главная кнопка. Сдача остаётся справа, задание и «Что будет проверяться» — в начале первого этапа.
Работа без шагов выглядит как раньше.
Как написать шаги
Шаги — поле steps работы в документе курса. Писать их удобно текстом — в репозитории курса или попросив Codex:
## Подготовка
Поставить инструменты — один раз на весь курс.
### Приложение ChatGPT {#app}
Поставь приложение ChatGPT и войди: [chatgpt.com/download](https://chatgpt.com/download).
[Готово] [Не ставится → Скачивай только с chatgpt.com/download и войди тем же аккаунтом.]
---
### Открой папку в Codex {#open}
Напиши в Codex:
```в Codex
Используй Экипаж. Настрой папку под меня.
```
> **Например:** «Я делаю ремонт квартир, клиенты — семьи с детьми».
? Какой ответ даст Экипажу больше?
- [ ] «Делаем качественно и в срок» → Так пишут все в нише.
- [x] «Сдали кухню за день до праздника» → История — из неё вырастет пост.
[Профиль появился] [У меня Windows → #win]
---
## Сдача
### Сохрани и отправь {#push}
> проверка: профиль/бизнес.md
---
### Попроси PR {#pr}
[PR создан → сдать]---— граница шагов.## Этап— название группы шагов, держится до следующей. Текст сразу под ним, до первого шага, — цель этапа: зачем он, одной-двумя фразами. Делайте этапы по 3–5 шагов: длинный путь без остановок бросают вдвое чаще.### Заголовок {#ключ}— заголовок шага и его ключ. По ключу считается, кто какие шаги прошёл, поэтому ключ не меняйте, когда правите текст. Без{#ключ}ключ берётся из заголовка.- Текст шага — обычный markdown: жирное,
код, ссылки, списки,#### подзаголовок. Абзац вида «Термин — что это» становится карточкой определения. - Блок кода участник копирует одной кнопкой. После трёх обратных кавычек — язык для подсветки и подпись:
```bash в терминале; только подпись —```в Codex. отдельной строкой — картинка с подписью, по клику открывается крупно. Источник необязателен; у чужих снимков пишите его с лицензией, например «GitHub Docs, CC BY 4.0».> текст— подсказка от имени курса, пузырём слева;> **Например:** …— с подписью над ним.? Вопроси варианты- [x] верный → почему,- [ ] неверный → почему— «Проверь себя». Верных может быть несколько, пояснение необязательно. Шаг дальше не держит: ошибся — увидел, почему, и пошёл дальше.- Кнопки — строкой в квадратных скобках:
[Готово]— шаг пройден, следующий. Первая такая кнопка — главная, её подпись остаётся ответом участника;[Не получается → текст]— подсказка. Подсказки шага собираются за кнопкой «Не получается» вместе с «Отложить шаг и идти дальше»;[У меня Windows → #ключ]— переход к шагу-ветке. Шаги, на которые ведут переходы, видны только тем, кто их выбрал, и в счёт не входят;[Готово → сдать]— шаг пройден, страница подсвечивает сдачу справа.
> проверка: путь— шаг засчитывается, только когда файл есть в репозитории участника: в основной ветке или в открытом PR. У такого шага кнопка «Проверить»; если репозитория на платформе нет или файл лежит в другом месте, участник отметит шаг сам.
Три вещи, о которые легко споткнуться:
- Шаг, на который ведёт хоть одна кнопка, из общего пути пропадает — его увидят только те, кто нажал эту кнопку. Если шаг нужен всем, не ставьте на него переход: пусть кнопка «Уже сделал» просто ведёт дальше. Из шага-ветки участник возвращается на общий путь, ветка в ветку не ведёт.
- Текстовая форма разбирается построчно, и блок кода её не останавливает. Строка внутри блока, которая начинается с
##,###,---,> проверка:или состоит из[…], будет прочитана как разметка шагов. Пример README с заголовком пишите без решёток. - В подсказке кнопки не ставьте
]и вторую стрелку→: текст после неё потеряется.
Переменные
В тексте шага, в подписи кнопки и в подсказке можно писать {{переменная}} — у каждого участника там будет своё:
| переменная | что подставится |
|---|---|
{{name}} | как человек записан в организации |
{{first_name}} | имя |
{{login}} | логин в хостинге кода курса |
{{repo}} | своя папка (репозиторий) — ссылкой; в ссылке [текст]({{repo}}) — её адрес |
{{repo_url}} | адрес своей папки текстом |
{{course}} | название курса |
{{run}} | название потока |
{{team}} | команда, если курс командный |
{{work}} | номер работы |
{{due}} | срок сдачи |
Папки ещё нет — вместо {{repo}} будет «ссылка появится через минуту»: на курсе без команд платформа заводит её сразу, как человек вошёл по коду.
Ошибки — переход на шаг, которого нет, повтор ключа, неизвестная переменная — платформа покажет при проверке курса, до публикации.
Что видят участник и ведущий
Каждый этап — своя страница: номер, название, цель, шаги по порядку; будущие откроются по ходу. В конце этапа — «Дальше — «следующий этап»», сверху — этапы полосками, к пройденным можно вернуться. Ответ участника остаётся пузырём справа с его именем. Всё сохраняется: закрыл страницу — вернётся туда же, с ответами и «Проверь себя».
На командном курсе шаги у каждого свои: кто что прошёл и как ответил, хранится на человека. А > проверка: смотрит общий репозиторий команды — выложил файл один, шаг засчитается у всех. В шагах с общим действием (завести ветку, открыть PR) дайте кнопку «Сделал товарищ», чтобы второй участник не делал то же самое.
Не получается — участник откладывает шаг и идёт дальше. Отложенные шаги видны ему справа, а проверяющему — на странице работы человека, вместе с тем, где открывали подсказки: их стоит учесть при проверке. Отложить — не потерять балл: шаги на оценку не влияют.
Платформа записывает, какие шаги пройдены, отложены и где просили подсказку. По этому видно, на каком шаге люди застревают, — этот шаг и стоит переписать.