Правила написания гайда
⠀В данной статья собраны правила по написанию гайдов и статей.
Содержание
⠀Этот элемент называется «Оглавление» и автоматически составляется на основе заголовков H2 и подзаголовков H3.
Название
⠀Название статьи центруется и состоит из названия проекта и названия тестовой сети (если нет названия, то Testnet
или Mainnet
), которые разделяются знаком |
.
Шаблон
⠀После указания названия новой статьи необходимо скопировать и вставить шаблон.
⠀После задания названия и вставки шаблона в правом верхнем углу нажать на кнопку публикации
Приватность поста
— Скрыта;Ссылка
— только название проекта в официальном регистре, например: Massa, assetMantle, SSV;Шаринг
⠀Скрытая статья удобнее черновика, поскольку можно посмотреть конечный вид статьи для пользователя и её сложнее случайно удалить.
Краткое описание
⠀Сначала идёт превью статьи (пока что создаётся SecorD’ом), затем краткое описание.
⠀Краткое описание в начале должно влезать в настройках при публикации статьи.
Текст и команды
⠀В большинстве случаев нужные словосочетания и команды уже есть в других гайдах, поэтому их можно скопировать и вставить, а затем отредактировать при необходимости.
⠀У всех абзацев использовать знак >⠀< в качестве красной строки для более лёгкой ориентации в тексте — чтобы текст не был сплошной стеной.
⠀Использовать неопределённые формы глаголов, поскольку это техническая документация, например:
- Обновить пакеты
- Установить необходимые пакеты
- Удостовериться, что нода запустилась и начала синхронизироваться
- Необходимо сохранить мнемоническую фразу
- Если не было установлено, то установить
⠀В такого вида
текст форматировать:
⠀При этом на таком тексте не должно быть никакого другого форматирования, иначе перед текстом будет такой
отросток.
⠀Прочее форматирование текста нежелательно.
⠀Для команд использовать специальный тип форматирования под названием
Код
⠀Если это Linux команда, то в настройках цветовой гаммы кода выбрать Bash.
⠀Для удобства копирования длинных команд можно либо переносить часть команды на следующую строку при помощи \
. <(wget -qO- https://raw.githubusercontent.com/______/______/main/multi_tool.sh) \ "Вот так"
⠀Либо делать 2 отступа при помощи Shift + Enter
Неправильно . <(wget -qO- https://raw.githubusercontent.com/______/______/main/multi_tool.sh)
Неправильно . <(wget -qO- https://raw.githubusercontent.com/______/______/main/multi_tool.sh)
Правильно . <(wget -qO- https://raw.githubusercontent.com/______/______/main/multi_tool.sh)
⠀Если нужно выйти из области кода, но 2 отступа мешают сделать это (при нажатии на Enter 2 отступа пропадают), то можно добавить букву на последней строке, нажать Enter
, а затем удалить букву в последней строке кода
. <(wget -qO- https://raw.githubusercontent.com/______/______/main/multi_tool.sh) Ы
⠀Букву Ы
надо удалить, а тут продолжить текст
Ссылки
⠀Ссылки необходимо делать не задевая последующий пробел < так не надо.
Скриншоты
⠀Размер скриншотов можно не уменьшать, главное, чтобы можно было разобрать содержимое.
⠀На скриншоты накладывается водяной знак (пока что SecorD’ом), чтобы при наглом копировании статьи виновнику торжества пришлось помучаться.
Заливка
⠀Скриншоты и задний фон области кода не заливать, поскольку это уменьшает их размер.
Заголовок
⠀Перед заголовком должна идти полоса, которую можно поставить написав на новой строке.
---
⠀После заголовка идёт ссылка на содержание.
Подзаголовок 1
⠀Перед подзаголовком должен быть пропуск строки, ссылки на содержание нет.
Подзаголовок 2
Завершение
⠀После написания статьи пройтись по всем абзацам и оттипографить текст (перенос предлогов к словам, превращение - в — и т.д.). Для этого необходимо выделить абзац и нажать на значок как на скриншоте ниже
⠀Если SecorD’ом была выдана превью статьи, то необходимо обновить шаблонную в статье и в настройках при публикации.
⠀При внесении изменений в краткое описание не забыть изменить его в настройках при публикации.
⠀Прочитать ещё 2 раза, и, если всё нормально, то опубликовать статью, выбрав в настройках публикации Приватность поста
сначала значение Черновик
, чтобы сбросить дату публикации, а затем Доступна всем
.