Корректура — Как писать классные тексты

Как мы оформляем уроки
Какие правила важно соблюдать
Как писать иностранные слова и названия
Сложные слова и термины
Практические советы

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

Ваша ценность как эксперта не упадет от неверных запятых — это ответственность редактора. Но если вы хотите прокачивать свою работу с текстами, можете вносить и корректорские правки с помощью 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, а завтра будем создавать курсы для питонистов. При этом Хекслету как платформе нужно соблюдать единые формулировки во всех текстах, иначе мы запутаем студентов.

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

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

Правильно

Неправильно

Комментарий

CEO (директор)

SEO, сеошник

Chief Executive Officer — исполнительный директор

CodePen

Codepen, кодпен

Docker

Докер

Бренды и программы пишем на английском

JavaScript или JS

Javascript

Markdown

Маркдаун

Node.js

node.js, NodeJS

SEO, сеошник

SEO-оптимизация, СЕО

Search Engine Optimization — поисковая оптимизация

URL

Урл

YouTube, ютуб-канал

Youtube, ютуб, ютьюб, YouTube-канал

Бэкенд

Бэкэнд, бекенд, бек-энд

По словарю Веб-стандартов

Бэктик `

Бектик

По словарю Веб-стандартов

Веб-разработка

Вэб-разработка, web-разработка

По словарю Веб-стандартов

Веб-сайт

Web-сайт

ВКонтакте или ВК

Вконтакте

Деструктуризация

Дестракчеринг

Изменяемость

Мутабельность

Импорт

Импортирование

Колбек

Коллбек, колбэк, коллбэк

Лендинг

Лэндинг

Неизменяемость

Иммутабельность

Онлайн

Он-лайн, он лайн

Опенсорс, опенсорс-проект, открытый проект, проект с открытым исходным кодом

Open source, opensource, опен сорс, опен-сорс

Отладка

Дебаг, дебаггинг

Офлайн

Оф-лайн, офф-лайн

Посмотри в интернете

Посмотри в Интернете

Без кавычек, с маленькой буквы, кириллицей, в нужном падеже

Продакшен

Production, продакшн, продакшэн

По словарю Веб-стандартов

Рантайм

Runtime, среда исполнения

Расширение файла

Суффикс

Трейсбек

Трэйсбек, трассировка

Фейсбук, Facebook

Фэйсбук

Флекс, флекс-контейнер

Флэкс, флэкс-контейнер

Фреймворк

Фрэймворк

Фронтенд

Фронтэнд, фронт-енд, фронт-энд

Функциональность

Функционал

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

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

Самостоятельная работа

Исправьте ошибки и оформите этот текст по стандартам, описанным в уроке:

Поделимся несколькими лайфхаками, которые помогут лучше адаптироваться на новом месте в айти компании: 1) Покажите свою заинтересованность и желание поскорее вникнуть в работу. Расспросите, какими корпоративными ресурсами пользуются в компании, какие есть дополнительные инструменты для реализации задач. Обычно коллеги рады погрузить во все процессы. 2) Проявляйте интерес к знакомству с коллегами. Так, вы обретёте поддержку, а может и 2-3 друзей на рабочем месте. Людям нравиться, когда ими интересуются; 3) Делитесь вкусняшками. Принести угощение - это первый шаг к сближению, который отлично работает. Сходите вместе на обед, познакомьтесь с коллегами в неформальной обстановке. Если есть возможность - посетите совместно концерт или организуйте вылазку на природу. Всё это очень сближает. 5) Активно участвуйте во всех зум активностях, если вы оказались в другом городе. Это поможет познакомиться и быстрее влиться в рабочие процессы. Особенно, хорошо это работает в распределенных командах - что не редкость в текущее время. 6) Умейте считывать информацию о корпоративной культуре компании. Она проявляется в деталях и ньюансах: о чём говорят сотрудники во время лэнча, как реагируют на руководство, какой дресс-код, какие отношения внутри команды.Отнеситесь с пониманием к негласным законам, которые приняты в компания.

Нажмите, чтобы увидеть ответ

Мы исправили ошибки и применили стандарты из урока:

Поделимся несколькими лайфхаками, которые помогут лучше адаптироваться на новом месте в IT-компании:

1. Покажите свою заинтересованность и желание поскорее вникнуть в работу. Расспросите, какими корпоративными ресурсами пользуются в компании, какие есть дополнительные инструменты для реализации задач. Обычно коллеги рады погрузить во все процессы
2. Проявляйте интерес к знакомству с коллегами. Так вы обретете поддержку, а может и двух-трех друзей на рабочем месте. Людям нравится, когда ими интересуются
3. Делитесь вкусняшками. Принести угощение — это первый шаг к сближению, который отлично работает. Сходите вместе на обед, познакомьтесь с коллегами в неформальной обстановке. Если есть возможность, посетите совместно концерт или организуйте вылазку на природу. Все это очень сближает
4. Активно участвуйте во всех активностях в Zoom, если вы оказались в другом городе. Это поможет познакомится и быстрее влится в рабочие процессы. Особенно хорошо это работает в распределенных командах, что не редкость в текущее время
5. Умейте считывать информацию о корпоративной культуре компании. Она проявляется в деталях и нюансах: о чем говорят сотрудники во время лэнча, как реагируют на руководство, какой дресс-код, какие отношения внутри команды. Отнеситесь с пониманием к негласным законам, которые приняты в компании