Теория: Корректура

Корректура — это последний уровень работы над уроком. Он про верно расставленные запятые, правописание и правила русского языка в целом.

Ваша ценность как эксперта не упадет от неверных запятых — это ответственность редактора. Но если вы хотите прокачивать свою работу с текстами, можете вносить и корректорские правки с помощью Language Tool — этот сервис автоматически находит большую часть ошибок по орфографии и пунктуации.

Также можете ориентироваться на наши рекомендации по оформлению текста. Если вы будете правильно оформлять текст, редакторы смогут быстрее работать с вашими уроками — студенты быстрее увидят новый контент на платформе.

Как мы оформляем уроки

В этом разделе поговорим об оформлении уроков на Gitlab.

Заголовки

В тексте мы используем заголовки двух уровней:

• ## (H2, два символа равно) — заголовок верхнего уровня
• ### (H3, три символа равно) — заголовок нижнего уровня

Каждый заголовок отбивается пустой строкой.

В начале урока прописывать его название не нужно. Название каждого урока мы добавляем в файл spec.yml.

Обратите внимание, что внутри текста обязательно использовать подзаголовки. Это позволит визуально разделить текст и структурировать его для читателя.

Форматирование текста

Обратите внимание, что все абзацы отбиваются пустой строкой:

Умение работать в команде — одно из самых частых требований в вакансии. Настоящий командный игрок легко становится своим в любой компании.

Такой человек придет на помощь, приободрит в случае неудачи, сможет признать свою ошибки, не станет зачинщиком конфликта.

Как преуспеть в командной работе? Для начала важно четко понять круг обязанностей, зону своей ответственности и выполнять свои обязательства, не подводя коллег.

Еще нужно научиться принимать критику и получать удовольствие от совместной работы.

Списки

Пункты списков пишем с большой буквы и без знаков препинания в конце:

Языки программирования:

* Python
* Java
* PHP

А еще можно изучать фреймворки.

В начале и конце списка не забудьте добавить пустую строку:

Языки программирования:

1. Python
2. Java
3. PHP

А еще можно изучать фреймворки.

Выпадающие списки

Пункты выпадающего списка оформляем так же, как и обычные списки: с большой буквы и без знаков препинания в конце. Еще нужно заключить список в тег <details></details> и прописать название списка в тегах добавить теги <summary></summary>. Не забудьте добавить пустые строки между пунктами:

<details>
<summary>Языки программирования:</summary>

1. Python
2. Java
3. PHP

</details>

А еще можно изучать фреймворки.

Какие правила важно соблюдать

Далее мы ответим на несколько вопросов по правилам русского языка. По нашему опыту, именно с этими аспектами чаще всего возникают сложности.

Как пишутся числительные

Числительные от нуля до десяти пишем буквами:

✏️ На задачу уйдет около восьми часов // конкретное число На задачу уйдет от восьми до девяти часов // диапазон

Числительные больше десяти пишем цифрами: ✏️ На задачу уйдет около 14 часов // конкретное число На задачу уйдет около 14-15 часов // диапазон

Когда ставить дефис, а когда — тире

Коротко разберем разницу между этими знаками:

• Дефис — это короткая черта. Она используется на уровне слов:

  • Осталось совсем чуть-чуть (Повтор слова)
  • А что осталось-то? (Слово с частицей -то)
  • Пять-семь строчек кода (Диапазон чисел)

• Тире — это длинная черта. Она используется внутри предложений:

  • Python — это язык программирования
  • Python = язык программирования

Если между словами хочется поставить знак =, значит нужно тире.

💡 Тире нет на клавиатуре, можно набрать его через Alt+0151 на NumPad.

Как использовать букву ё

По умолчанию мы не используем букву ё. Это стандарт, принятый во многих современных СМИ и медиа. Он помогает соблюдать единообразие на платформе: автоматически заменить ё на е проще, чем вручную расставлять ё во всех текстах.

Из этого правила есть два исключения.

Мы используем ё:

1 — Там, где текст получается двусмысленным без ё:

✏️ Мы все решили (Решили вместе) Мы всё решили (Решили все задачи)

2 — В именах, фамилиях и географических названиях:

✏️ Ученый Ёсинори Осуми переехал в Кёльн

Как писать иностранные слова и названия

Английские слова приходят в русский язык и со временем подстраиваются под его правила. Людям неудобно постоянно говорить и писать с вставками из другого языка, поэтому мы коверкаем новые слова и укладываем в привычную речь.

💡 Этот процесс выглядит так:

• Поищи ответ в поисковой системе Google // С пояснением и по-английски
• Поищи ответ в Google // Ушло пояснение
• Поищи ответ в «Гугл» // По-русски, но в кавычках и с заглавной буквы
• Поищи ответ в Гугл // Ушли кавычки
• Поищи ответ в гугл // Ушла заглавная буква
• Поищи ответ в гугле // Появилось изменение по падежам
• Прогугли эту тему // Появились слова с новым корнем

Каждое заимствованное слово проходит этот путь. Это нормально, что вчера мы писали про Python, а завтра будем создавать курсы для питонистов. При этом Хекслету как платформе нужно соблюдать единые формулировки во всех текстах, иначе мы запутаем студентов.

Поэтому мы собрали список терминов — постарайтесь придерживаться этого стандарта в уроках.

Сложные слова и термины

Практические советы

• Если термина нет в списке сложных терминов, можно поискать правильное написание в словаре сообщества «Веб-стандарты»

• Не забывайте чаще заглядывать в этот урок, чтобы сверяться с правилами и списком сложных терминов

• Предлагайте свои термины, в которых часто ошибаются в курсах и IT-сообществе в целом. Это можно сделать, нажав Ctrl+Enter — откроется форма «Сообщите об ошибке на странице»