Добавлена документация репозитория
@@ -1,176 +1,27 @@
|
||||
# mobile-iOS
|
||||
# Mobile iOS
|
||||
|
||||
# Структура уроков: чек-лист для авторов
|
||||
В данном репозитории находится текст
|
||||
уроков [Яндекс.Практикума по курсу iOS-разработчик»](https://practicum.yandex.ru/ios-developer/).
|
||||
|
||||
Привет! Это формальные штуки, которые должны быть в каждом уроке 👌
|
||||
🤝 Клонируя этот репозиторий, разработчик обязуется поддерживать всю документацию в актуальном состоянии.
|
||||
|
||||
Рассмотрим два шаблона: стандартный урок ([пример](https://practicum.yandex.ru/learn/ios-developer/courses/6aebbc23-2480-4618-9999-3a7555e7156c/sprints/79799/topics/ee995b7e-db71-46ad-8f20-865db996a7a0/lessons/c01fe6b3-d788-4242-9519-800d0502211a/)) и урок с задачей ([пример](https://practicum.yandex.ru/learn/ios-developer/courses/6aebbc23-2480-4618-9999-3a7555e7156c/sprints/79799/topics/0c0b0912-4577-4157-9131-6383e4f1f8ef/lessons/f37bff1e-3a9a-4bc1-8e89-0e6f524ed9c0/)).
|
||||
## Навигация
|
||||
|
||||
## 0. Название
|
||||
Принятые договорённости:
|
||||
|
||||
Должно быть:
|
||||
- [Код-стайл уроков](./docs/codestyle/codestyle.md).
|
||||
- [Описание структуры](./docs/structure/Структура%20уроков.md)
|
||||
- [Если нужна иллюстрация](./docs/illustration/Если%20нужна%20иллюстрация%20в%20урок.md)
|
||||
- [Оформление скриншотов](./docs/illustration/Как%20делать%20скрины%20и%20гифки%20для%20уроков.md)
|
||||
|
||||
## Структура репозитория
|
||||
|
||||
- у каждой темы
|
||||
- у каждого урока!
|
||||
- [`freetrack`](./freetrack) - бесплатная часть курса Фритрек
|
||||
- [`lessons`](./lessons) - yроки основной части программы
|
||||
- [`lessons-extended-program`](./lessons-extended-program) - уроки расширенной программы курса
|
||||
- `.github` - описание CI/CD pipeline на основе GitHub Actions и базовые шаблоны для GitHub
|
||||
- `docs`– документация проекта
|
||||
|
||||
Черновое название темы определяем на декомпозиции спринта. Если в процессе появляется ощущение, что нужно менять — меняем (советуемся в чатике с авторами, редактором Юлей и методисткой Настей). То же относится к названиям уроков.
|
||||
## Команда проекта
|
||||
|
||||
Название темы или урока должно должно отображать суть того, о чём говорится внутри.
|
||||
|
||||
Хороший пример: «Основы вёрстки кодом» (конкретика)
|
||||
|
||||
Плохой пример: «Учимся новому» (абстракция)
|
||||
|
||||
---
|
||||
|
||||
🚀*В GitHub писать названия уроков нужно по-русски (кроме терминов), а не латиницей — во избежание разночтений.*
|
||||
|
||||
---
|
||||
|
||||
## 1. **Введение**
|
||||
|
||||
**1.1** **Введение** — это пара абзацев в общем тексте первого урока или же отдельный **урок-онбординг**. Кратко, в 2–3 пунктах, **напоминаем** студентам, о чём шла речь в предыдущей теме.
|
||||
|
||||
Хорошая практика для введения — связать текущую тему с предыдущими. Это можно сделать **с помощью проекта** («в прошлой теме мы сделали такой-то экран, но на кнопочку всё ещё нельзя тыкнуть, этим мы займёмся тут»), а можно **связать концепции, инструменты или технологии**, о которых говорим в соседних темах.
|
||||
|
||||
**Перечисляем, что будет** в этой теме, с чем студенты познакомятся, какие задачи перед ними будут стоять. Упоминаем термины, инструменты, процессы и то, как они используются.
|
||||
|
||||
**Пример**
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
🚀*Самого подзаголовка «Введение» **не нужно**! На платформе как подзаголовок отображается название урока, текст начинается сразу за ним.*
|
||||
|
||||
---
|
||||
|
||||
**1.2** Обязательно добавляем информацию о предстоящем **домашнем задании** (если оно предполагается)*:
|
||||
|
||||
**Пример**
|
||||
|
||||

|
||||
|
||||
* Этот текст может отличаться — в зависимости от проекта, над которым студенты работают в текущем модуле. Но в рамках одного проекта текст должен оставаться тем же (**просто копируем**, меняя номер спринта)
|
||||
|
||||
---
|
||||
|
||||
🚀*Дописать вступление и заключение можно после того, как будет готов весь текст. Начните с примеров и терминов, затем дописывайте к ним теорию.*
|
||||
|
||||
---
|
||||
|
||||
## 2. **Основной текст**
|
||||
|
||||
**2.1** **Структура урока.** Текст не должен идти сплошным полотном. Чтобы студентам было проще воспринимать информацию, рекомендуется давать подряд максимум **2-3 абзаца** (после — выделение в рамочку или фоном или др. элемент, на котором внимание может «отдохнуть»).
|
||||
|
||||
**Как разбивать текст на абзацы:**
|
||||
|
||||
- с помощью подзаголовков
|
||||
- кнопкой «Далее»
|
||||
- «кастомной» кнопкой, в которой есть вопрос или побуждение к действию и т.д. («Понятно!», «Что дальше?», «Я молодец!»)
|
||||
|
||||
🚀*Приятно, когда с тобой общаются уважительно и проявляют заботу. Реплики-кнопки в ответах, проверочных заданиях, конце темы — позитивно влияют на студента.*
|
||||
|
||||
---
|
||||
|
||||
**Некоторые подзаголовки у нас стандартные:**
|
||||
|
||||
- Для исторической справки: **«Щепотка истории»**
|
||||
- Для квизов: **«Проверим изученное» (НЕ! КВИЗ)**
|
||||
- Для заключения: **«Подведём итоги» (НЕ! ЗАКЛЮЧЕНИЕ)**
|
||||
- Для задач внутри спринта или домашек: **«Самостоятельная работа»**
|
||||
- Для авторского решения: **«Авторское решение»**
|
||||
|
||||
🚀Сразу после АР идёт текст:
|
||||
|
||||
*Советуем посмотреть авторское решение только после того, как вы сами попробовали решить задачу. С ним можно сверяться, хотя оно может отличаться от вашего решения.*
|
||||
|
||||
---
|
||||
|
||||
**2.2** **Тезисы.** Выделяйте важные идеи — например, **в рамочку** или **фоном** (не нужно самим рисовать, просто оставьте комментарий, что этот кусок текста надо выделить).
|
||||
|
||||
**На платформе будет выглядеть так:**
|
||||
|
||||

|
||||
|
||||
**2.3** **Термины**, которые мы объясняем впервые, надо **расшифровывать**. Это делается с помощью глоссария — подсказок, которые всплывают при наведении мышки на выделенное слово. В Git пишем прописными **ГЛОССАРИЙ**, затем — объяснение:
|
||||
|
||||

|
||||
|
||||
**На платформе будет выглядеть так:**
|
||||
|
||||

|
||||
|
||||
**2.4 Списки.** Если в предложении есть перечисление после двоеточия, оформляйте его **списком**, а не через запятую. Так информацию:
|
||||
|
||||
- *проще воспринимать;*
|
||||
- *легче воспринимать;*
|
||||
- *сразу видно!*
|
||||
|
||||
---
|
||||
|
||||
🚀В тексте урока иногда нужно выделить важные повторяющиеся фрагменты. Если вы понимаете, что в вашем уроке есть такие, посмотрите, как это было оформлено в предыдущих темах.
|
||||
|
||||
**Примеры текстов-предупреждений:**
|
||||
|
||||
*Мы рекомендуем самостоятельно переписывать и вставлять в проект любые, даже самые маленькие кусочки кода, которые будут вам встречаться. Только так вы наработаете навык программирования.*
|
||||
|
||||
= = = = = = =
|
||||
|
||||
*Вы можете попробовать применить наши примеры к проекту Movie Quiz в отдельной ветке. Но отправлять это на ревью не нужно! Все примеры кода в этом уроке — иллюстративные. Они нужны, чтобы раскрыть суть принципов SOLID. Если у вас возникнут вопросы — не бойтесь просить помощи у наставников!*
|
||||
|
||||
---
|
||||
|
||||
## 3. Иллюстрации
|
||||
|
||||
В уроке должна быть **минимум 1 художественная** иллюстрация — для поддержания единого «космического» нарратива. Иллюстрация помогает отдохнуть или обратить внимание на важную часть теории.
|
||||
|
||||
Также обязательно должны быть **скриншоты и/или гифки**, поясняющие и дополняющие материал.
|
||||
|
||||
## 4. Квизы
|
||||
|
||||
Они же — раздел с подзаголовком «Проверим изученное». Помимо вопроса и вариантов ответов, должны содержать пояснения к ответам.
|
||||
|
||||
**Пример**
|
||||
|
||||

|
||||
|
||||
Подробнее о квизах — какими они бывают и как их делать — пожалуйста, прочитайте [вот тут](https://www.notion.so/a1a785748f384403b2a5a3e63076a2b8).
|
||||
|
||||
А это — [чек-лист про квизы](https://www.notion.so/c6a3dbbca31c4f10b683b6edf6ad9526), который собирала Настя. Ознакомьтесь!
|
||||
|
||||
## 5. **Заключение**
|
||||
|
||||
Выводы о том, что мы прошли в этом уроке («Подведём итоги»). В нём должно быть перечисление главных новых штук, которые мы изучили, их определения и связи между собой + делаем подводку к следующему уроку или теме.
|
||||
|
||||
**Пример**
|
||||
|
||||

|
||||
|
||||
# Урок «Сдаём задачу по спринту Х»
|
||||
|
||||
Он же — практическое задание. Это на 90% шаблон, в котором должны быть:
|
||||
|
||||
### 1. Стандартное введение
|
||||
|
||||
*Вы завершили спринт №Х и сделали то-то и то-то. Пришло время сдавать задачу на ревью!*
|
||||
|
||||
Вам нужно сдать проект, в котором есть:
|
||||
|
||||
- перечисление основных, что нужно сделать
|
||||
|
||||
*Выполните задачу по спринту в Xcode. Залейте её в отдельную ветку на GitHub с названием sprint_номер урока. Важно: проект должен быть открытым!*
|
||||
|
||||
### 2. Чек-лист «Убедитесь, что»
|
||||
|
||||
Перечень всех задач, которые мы давали в качестве самостоятельной работы на протяжении модуля.
|
||||
|
||||
### 3. Стандартное заключение
|
||||
|
||||
*Если все пункты совпали — смело отправляйте задание на ревью!*
|
||||
|
||||
*Скопируйте ссылку на пулл-реквест и вставьте её в специальную форму «Ревью» справа.*
|
||||
|
||||
*Ожидайте письма об окончании ревью на почту, с который вы зарегистрированы в Практикуме. Ревьюер скоро напишет вам и даст обратную связь!*
|
||||
|
||||
💃💃💃
|
||||
// TODO
|
||||
|
After Width: | Height: | Size: 120 KiB |
|
After Width: | Height: | Size: 33 KiB |
|
After Width: | Height: | Size: 74 KiB |
|
After Width: | Height: | Size: 108 KiB |
|
After Width: | Height: | Size: 86 KiB |
|
After Width: | Height: | Size: 168 KiB |
|
After Width: | Height: | Size: 41 KiB |
|
After Width: | Height: | Size: 173 KiB |
|
After Width: | Height: | Size: 161 KiB |
|
After Width: | Height: | Size: 124 KiB |
|
After Width: | Height: | Size: 195 KiB |
|
After Width: | Height: | Size: 237 KiB |
|
After Width: | Height: | Size: 142 KiB |
|
After Width: | Height: | Size: 145 KiB |
|
After Width: | Height: | Size: 135 KiB |
|
After Width: | Height: | Size: 143 KiB |
|
After Width: | Height: | Size: 136 KiB |
|
After Width: | Height: | Size: 387 KiB |
|
After Width: | Height: | Size: 277 KiB |
|
After Width: | Height: | Size: 128 KiB |
|
After Width: | Height: | Size: 88 KiB |
|
After Width: | Height: | Size: 123 KiB |
|
After Width: | Height: | Size: 35 KiB |
|
After Width: | Height: | Size: 101 KiB |
|
After Width: | Height: | Size: 91 KiB |
|
After Width: | Height: | Size: 54 KiB |
|
After Width: | Height: | Size: 322 KiB |
|
After Width: | Height: | Size: 90 KiB |
|
After Width: | Height: | Size: 273 KiB |
|
After Width: | Height: | Size: 312 KiB |
|
After Width: | Height: | Size: 268 KiB |
|
After Width: | Height: | Size: 677 KiB |
|
After Width: | Height: | Size: 792 KiB |
|
After Width: | Height: | Size: 812 KiB |
|
After Width: | Height: | Size: 1.1 MiB |
|
After Width: | Height: | Size: 776 KiB |
|
After Width: | Height: | Size: 918 KiB |
|
After Width: | Height: | Size: 172 KiB |
|
After Width: | Height: | Size: 247 KiB |
|
After Width: | Height: | Size: 658 KiB |
|
After Width: | Height: | Size: 434 KiB |
@@ -0,0 +1,17 @@
|
||||
|
||||
## Если нужна иллюстрация в урок
|
||||
|
||||
👉 Этот документ, копия [страницы по процессу в Wiki](https://wiki.yandex-team.ru/practicum/programming-practicum/stranicyko-0914/mobile-3b57/kursios-ra-cbfc/kakrabotat-0844/)
|
||||
|
||||
Ход работы с иллюстрациями: идея → ч/б эскиз → правки → результат
|
||||
|
||||
1. Вы пишите иллюстратору ТЗ: создаете задача в трекере.
|
||||
2. В тексте на Github пишем **КАРТИНКА / ИЛЛЮСТРАЦИЯ** в том месте, где она должна лежать****
|
||||
3. Все итерации и обсуждение иллюстраций проходят внутри созданной задачи в трекере
|
||||
4. Иллюстратор рисует ч/б → зовет вас → обсуждаете → рисуете цветной вариант → зовет вас → загружаем в папку assets в каждой теме → добавляем иллюстрацию в текст.
|
||||
5. **ВАЖНО!** Кидайте ваши предложения иллюстратору сразу, как возникла идея, так как нужно рассчитать время и если вы слишком поздно придумаете идею, то картинка может быть не отрисована
|
||||
|
||||
**Пример ТЗ на иллюстрацию:**
|
||||
|
||||
- **КАРТИНКА** Давай нарисуем здесь трёх волхвов, которые держат в руках три разных подарка и на небе в облаке написано “Jesus is about to be born”. Пример из гугла прикрепил к тексту
|
||||
- **СХЕМА** Тут нужно будет сделать схему приготовления борща. Четыре пункта: поиск рецепта, поход в магазин, приготовление, сервировка. Если нужно, могу приложить пример
|
||||
@@ -0,0 +1,67 @@
|
||||
# Как делать скрины и гифки для уроков
|
||||
|
||||
👉 Этот документ, копия [страницы по процессу в Wiki](https://wiki.yandex-team.ru/practicum/programming-practicum/stranicyko-0914/mobile-3b57/kursios-ra-cbfc/kakrabotat-0844/)
|
||||
|
||||
---
|
||||
|
||||
👉 [Ссыль на скриншотницу](https://www.figma.com/file/RbV09DwRw5E8XahFVXdQzp/%D0%A8%D0%B0%D0%B1%D0%BB%D0%BE%D0%BD%D1%8B-%D1%81%D0%BA%D1%80%D0%B8%D0%BD%D1%88%D0%BE%D1%82%D0%BE%D0%B2?node-id=0%3A1) в Figma
|
||||
|
||||
> 🎯 Важно: скриншоты должны быть **максимально большие** (но с отступами, информация о них ниже) → иначе на платформе ничего не видно
|
||||
|
||||
### **Приступаем к созданию скриншотов для своей темы**
|
||||
|
||||
- Заходим в фигму по ссылке, затем:
|
||||
- Заходим на страницу “Шаблоны“, выбираем какой-то artboard, копируем его `Cmd+C` , затем возвращаемся на личную страничку в фигме, где вы деалаете скриншот, и вставляем `Cmd+V` . В артборде уже настроен экспорт, фон и контур. Так что **создавать свои артборды с нуля** не стоит чтобы не было расхождений.
|
||||
- Артборд называем соответственно `sprint-x/theme-x/part-x/screenshot-name` — `номер спринта / номер темы / номер урока / название скриншота` (тогда при экспорте все скриншоты уже будут рассортированы по папкам, то есть название artboard’а будет путем до картинки после экспорта)
|
||||
|
||||
> 💡 Сейчас каждый автор делает скриншот в своей личной фигме. Если нужна помощь иллюстратора, ссылку на свою фигму нужно приложить в задачу.
|
||||
|
||||
### **Контент скриншота**
|
||||
|
||||
- Скриншот лучше делать простой, без встроенной тени в mac os, так контент будет выглядеть однообразно. Чтобы снимок не содержал тени окна, **при щелчке удерживайте нажатой клавишу Option**. Если в углу экрана появится миниатюра, щелкните ее, чтобы отредактировать снимок экрана. Или дождитесь сохранения снимка экрана на рабочем столе
|
||||
- Скриншоты сложно привести к единому размеру, поэтому отступы даны условные для ориентира, от них можно отклоняться.
|
||||
- Отступы сверху и снизу были примерно 85~90 точек (можно зажать `Opt+Shift` и масштабировать скриншот чтобы смотреть как меняются отступы от краев artboard’а), а справа и слева - не меньше 240~250. Отступ от стрелки до объекта ~20
|
||||
- скругление 10 точек
|
||||
- тень: `x = 0, y = 4, blur = 10, spread 0, 25%`
|
||||
- Чтобы сделать обводку, или стрелочки — копируем нужный элемент со страницы **“Шаблоны”** и вставляем к себе. Также можно посмотреть кучу примеров стрелочек, лэйблов и обводок на странице “Фритрэк скриншоты” и скопировать элемент оттуда
|
||||
- Фон для скришотов по дефолту белый, но если у вас стоит светлая тема, то рекомендуется использовать серый фон #E6E8EB он есть в шаблонах фигмы
|
||||
|
||||
### **Экспорт скриншота**
|
||||
|
||||
- Когда один или несколько скриншотов готовы, выделяем все нужные нам artboard’ы на странице и нажимаем в правой боковой панель кнопочку `Export`
|
||||
- Экспортированные скриншоты перемещаем в папку с картинками `images` в папке своей темы.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
### Анимация и гифки
|
||||
|
||||
Если для урока требуется запись скринкаста или анимация **не размера десктоп**, то для нее понадобится подложка как и на скриншотах.
|
||||
|
||||
- Записать видео или скринкаст можно через Quick Time
|
||||
|
||||

|
||||
|
||||
- Гифки или видео можно также записать через симулятор
|
||||
- Для этого нужно выбрать симулятор и нажать **CMD+R** или **File > Record Screen**.
|
||||
- Результат можно превратить в Анимированную гифку (нужно выбрать соотвествующий пункт нажав “правой кнопкой мыши” на мини версию видео справа от симулятора, сразу после того, как видео было записано).
|
||||
|
||||
- На подложку проще всего класть именно видео, открыв его через IMovie. Там же можно выбрать цвет фона. Мы используем **белый.** Если ваше видео уже с большим количеством белого и черного цвета настолько, что фон мешает восприятию и просмотру, то используем серый фон #E6E8EB
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
|
After Width: | Height: | Size: 177 KiB |
|
After Width: | Height: | Size: 38 KiB |
|
After Width: | Height: | Size: 207 KiB |
|
After Width: | Height: | Size: 120 KiB |
|
After Width: | Height: | Size: 107 KiB |
|
After Width: | Height: | Size: 113 KiB |
|
After Width: | Height: | Size: 125 KiB |
@@ -0,0 +1,176 @@
|
||||
# Структура уроков: чек-лист для авторов
|
||||
|
||||
Привет! Это формальные штуки, которые должны быть в каждом уроке 👌
|
||||
|
||||
Рассмотрим два шаблона: стандартный урок ([пример](https://practicum.yandex.ru/learn/ios-developer/courses/6aebbc23-2480-4618-9999-3a7555e7156c/sprints/79799/topics/ee995b7e-db71-46ad-8f20-865db996a7a0/lessons/c01fe6b3-d788-4242-9519-800d0502211a/)) и урок с задачей ([пример](https://practicum.yandex.ru/learn/ios-developer/courses/6aebbc23-2480-4618-9999-3a7555e7156c/sprints/79799/topics/0c0b0912-4577-4157-9131-6383e4f1f8ef/lessons/f37bff1e-3a9a-4bc1-8e89-0e6f524ed9c0/)).
|
||||
|
||||
## Стандартный урок
|
||||
|
||||
### 0. Название
|
||||
|
||||
Должно быть:
|
||||
|
||||
- у каждой темы
|
||||
- у каждого урока!
|
||||
|
||||
Черновое название темы определяем на декомпозиции спринта. Если в процессе появляется ощущение, что нужно менять — меняем (советуемся в чатике с авторами, редактором Юлей и методисткой Настей). То же относится к названиям уроков.
|
||||
|
||||
Название темы или урока должно должно отображать суть того, о чём говорится внутри.
|
||||
|
||||
Хороший пример: «Основы вёрстки кодом» (конкретика)
|
||||
|
||||
Плохой пример: «Учимся новому» (абстракция)
|
||||
|
||||
---
|
||||
|
||||
🚀*В GitHub писать названия уроков нужно по-русски (кроме терминов), а не латиницей — во избежание разночтений.*
|
||||
|
||||
---
|
||||
|
||||
### 1. **Введение**
|
||||
|
||||
**1.1** **Введение** — это пара абзацев в общем тексте первого урока или же отдельный **урок-онбординг**. Кратко, в 2–3 пунктах, **напоминаем** студентам, о чём шла речь в предыдущей теме.
|
||||
|
||||
Хорошая практика для введения — связать текущую тему с предыдущими. Это можно сделать **с помощью проекта** («в прошлой теме мы сделали такой-то экран, но на кнопочку всё ещё нельзя тыкнуть, этим мы займёмся тут»), а можно **связать концепции, инструменты или технологии**, о которых говорим в соседних темах.
|
||||
|
||||
**Перечисляем, что будет** в этой теме, с чем студенты познакомятся, какие задачи перед ними будут стоять. Упоминаем термины, инструменты, процессы и то, как они используются.
|
||||
|
||||
**Пример**
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
🚀*Самого подзаголовка «Введение» **не нужно**! На платформе как подзаголовок отображается название урока, текст начинается сразу за ним.*
|
||||
|
||||
---
|
||||
|
||||
**1.2** Обязательно добавляем информацию о предстоящем **домашнем задании** (если оно предполагается)*:
|
||||
|
||||
**Пример**
|
||||
|
||||

|
||||
|
||||
* Этот текст может отличаться — в зависимости от проекта, над которым студенты работают в текущем модуле. Но в рамках одного проекта текст должен оставаться тем же (**просто копируем**, меняя номер спринта)
|
||||
|
||||
---
|
||||
|
||||
🚀*Дописать вступление и заключение можно после того, как будет готов весь текст. Начните с примеров и терминов, затем дописывайте к ним теорию.*
|
||||
|
||||
---
|
||||
|
||||
### 2. **Основной текст**
|
||||
|
||||
**2.1** **Структура урока.** Текст не должен идти сплошным полотном. Чтобы студентам было проще воспринимать информацию, рекомендуется давать подряд максимум **2-3 абзаца** (после — выделение в рамочку или фоном или др. элемент, на котором внимание может «отдохнуть»).
|
||||
|
||||
**Как разбивать текст на абзацы:**
|
||||
|
||||
- с помощью подзаголовков
|
||||
- кнопкой «Далее»
|
||||
- «кастомной» кнопкой, в которой есть вопрос или побуждение к действию и т.д. («Понятно!», «Что дальше?», «Я молодец!»)
|
||||
|
||||
🚀*Приятно, когда с тобой общаются уважительно и проявляют заботу. Реплики-кнопки в ответах, проверочных заданиях, конце темы — позитивно влияют на студента.*
|
||||
|
||||
---
|
||||
|
||||
**Некоторые подзаголовки у нас стандартные:**
|
||||
|
||||
- Для исторической справки: **«Щепотка истории»**
|
||||
- Для квизов: **«Проверим изученное» (!Не используем в названии КВИЗ)**
|
||||
- Для заключения: **«Подведём итоги» (!Не используем в названии ЗАКЛЮЧЕНИЕ)**
|
||||
- Для задач внутри спринта или домашек: **«Самостоятельная работа»**
|
||||
- Для авторского решения: **«Авторское решение»**
|
||||
|
||||
🚀Сразу после АР идёт текст:
|
||||
|
||||
*Советуем посмотреть авторское решение только после того, как вы сами попробовали решить задачу. С ним можно сверяться, хотя оно может отличаться от вашего решения.*
|
||||
|
||||
---
|
||||
|
||||
**2.2** **Тезисы.** Выделяйте важные идеи — например, **БЛОК** (не нужно самим рисовать, просто оставьте комментарий, что этот кусок текста надо выделить).
|
||||
|
||||
**На платформе будет выглядеть так:**
|
||||
|
||||

|
||||
|
||||
**2.3** **Термины**, которые мы объясняем впервые, надо **расшифровывать**. Это делается с помощью глоссария — подсказок, которые всплывают при наведении мышки на выделенное слово. В Git пишем прописными **ГЛОССАРИЙ**, затем — объяснение:
|
||||
|
||||

|
||||
|
||||
**На платформе будет выглядеть так:**
|
||||
|
||||

|
||||
|
||||
**2.4 Списки.** Если в предложении есть перечисление после двоеточия, оформляйте его **списком**, а не через запятую. Так информацию:
|
||||
|
||||
- *проще воспринимать;*
|
||||
- *легче воспринимать;*
|
||||
- *сразу видно!*
|
||||
|
||||
---
|
||||
|
||||
🚀В тексте урока иногда нужно выделить важные повторяющиеся фрагменты. Если вы понимаете, что в вашем уроке есть такие, посмотрите, как это было оформлено в предыдущих темах.
|
||||
|
||||
**Примеры текстов-предупреждений:**
|
||||
|
||||
*Мы рекомендуем самостоятельно переписывать и вставлять в проект любые, даже самые маленькие кусочки кода, которые будут вам встречаться. Только так вы наработаете навык программирования.*
|
||||
|
||||
= = = = = = =
|
||||
|
||||
*Вы можете попробовать применить наши примеры к проекту Movie Quiz в отдельной ветке. Но отправлять это на ревью не нужно! Все примеры кода в этом уроке — иллюстративные. Они нужны, чтобы раскрыть суть принципов SOLID. Если у вас возникнут вопросы — не бойтесь просить помощи у наставников!*
|
||||
|
||||
---
|
||||
|
||||
### 3. Иллюстрации
|
||||
|
||||
В уроке должна быть **минимум 1 художественная** иллюстрация — для поддержания единого «космического» нарратива. Иллюстрация помогает отдохнуть или обратить внимание на важную часть теории.
|
||||
|
||||
Также обязательно должны быть **скриншоты и/или гифки**, поясняющие и дополняющие материал.
|
||||
|
||||
### 4. Квизы
|
||||
|
||||
Они же — раздел с подзаголовком «Проверим изученное». Помимо вопроса и вариантов ответов, должны содержать пояснения к ответам.
|
||||
|
||||
**Пример**
|
||||
|
||||

|
||||
|
||||
Подробнее о квизах — какими они бывают и как их делать — пожалуйста, прочитайте [вот тут](https://www.notion.so/a1a785748f384403b2a5a3e63076a2b8).
|
||||
|
||||
А это — [чек-лист про квизы](https://www.notion.so/c6a3dbbca31c4f10b683b6edf6ad9526), который собирала Настя. Ознакомьтесь!
|
||||
|
||||
### 5. **Заключение**
|
||||
|
||||
Выводы о том, что мы прошли в этом уроке («Подведём итоги»). В нём должно быть перечисление главных новых штук, которые мы изучили, их определения и связи между собой + делаем подводку к следующему уроку или теме.
|
||||
|
||||
**Пример**
|
||||
|
||||

|
||||
|
||||
## Урок «Сдаём задачу по спринту Х»
|
||||
|
||||
Он же — практическое задание. Это на 90% шаблон, в котором должны быть:
|
||||
|
||||
### 1. Стандартное введение
|
||||
|
||||
*Вы завершили спринт №Х и сделали то-то и то-то. Пришло время сдавать задачу на ревью!*
|
||||
|
||||
Вам нужно сдать проект, в котором есть:
|
||||
|
||||
- перечисление основных, что нужно сделать
|
||||
|
||||
*Выполните задачу по спринту в Xcode. Залейте её в отдельную ветку на GitHub с названием sprint_номер урока. Важно: проект должен быть открытым!*
|
||||
|
||||
### 2. Чек-лист «Убедитесь, что»
|
||||
|
||||
Перечень всех задач, которые мы давали в качестве самостоятельной работы на протяжении модуля.
|
||||
|
||||
### 3. Стандартное заключение
|
||||
|
||||
*Если все пункты совпали — смело отправляйте задание на ревью!*
|
||||
|
||||
*Скопируйте ссылку на пулл-реквест и вставьте её в специальную форму «Ревью» справа.*
|
||||
|
||||
*Ожидайте письма об окончании ревью на почту, с который вы зарегистрированы в Практикуме. Ревьюер скоро напишет вам и даст обратную связь!*
|
||||
|
||||
💃💃💃
|
||||