Правка инструкции
Как менять эту инструкцию: разделы, статьи, скриншоты и ролики
Инструкция, которую вы читаете, хранится в базе сервиса и правится прямо из приложения — раздел Сервис → Правка инструкции. Изменения появляются на 2sklad.ru/help сразу после сохранения, обновлять сервер не нужно.
Скриншот: раздел «Правка инструкции»: слева оглавление, справа статья.
Править инструкцию может только владелец сервиса: она общая для всех складов.
Как устроено
- Раздел — папка со статьями. У него есть название, описание (видно на карточке в оглавлении) и порядок.
- Статья — одна страница. Заголовок, описание под ним, порядок внутри раздела и текст.
- Код раздела и статьи попадает в адрес:
2sklad.ru/help/03-administrator/05-tarify. Латинские буквы, цифры и дефис. Начинать код с номера удобно: так статьи видно в правильном порядке даже в списке файлов. - Порядок — число. Чем меньше, тем выше в оглавлении. Оставляйте зазоры (10, 20, 30), чтобы новую статью можно было вставить между старыми, ничего не перенумеровывая.
Как писать текст
Разметка простая:
## Заголовок раздела статьи
Обычный абзац. **Жирный** и *наклонный* текст, `код`.
- пункт списка
- ещё пункт
1. нумерованный пункт
2. следующий
> **Скриншот:** подпись — так помечают место для будущей картинки.
| Колонка | Ещё колонка |
|---|---|
| значение | значение |Заголовок статьи писать в тексте не нужно — он берётся из поля «Заголовок».
Кнопка Предпросмотр показывает, как разметка превратится в страницу, ничего не сохраняя. Кнопка Открыть в инструкции открывает статью так, как её видит читатель.
Скриншоты и ролики
Внизу формы — файлы раздела. Загрузите картинку (png, jpg, gif, webp, svg) или ролик (mp4, webm) до 25 МБ, и она появится в списке. Кнопка Вставить в текст ставит разметку туда, где стоит курсор:
{width=760}Число в фигурных скобках — ширина картинки в точках; уберите его, и картинка займёт всю ширину колонки. Ролик вставляется так же и превращается в плеер.
Имя файла приводится к латинице автоматически: оно попадает в адрес картинки. Файлы доступны всем статьям своего раздела.
Вопросы к тесту
Под текстом статьи — блок «Вопросы к тесту». Пока вопросов нет, статья в аттестации не участвует: так служебные страницы никого не беспокоят.
Кнопка «+ Вопрос» добавляет вопрос, «+ Вариант» — вариант ответа, галочка слева отмечает верный. Правила простые:
- вариантов должно быть не меньше двух;
- верных может быть несколько — отмечайте все;
- верных может не быть вовсе — тогда правильный ответ «ничего не отмечать». Такие вопросы отлично ловят того, кто щёлкает наугад, но злоупотреблять ими не стоит: один-два на тест.
Порядок вопросов и вариантов при прохождении перемешивается, поэтому писать «все перечисленное» или «ни один из вышеперечисленных» нельзя — «выше» не будет.
Тест пишет тот же человек, что и текст. Тест, написанный не автором, проверяет угадывание формулировок, а не понимание.
Кому раздел обязателен
В карточке раздела есть поле «Кому обязателен для аттестации»: список ролей через запятую — operator, keeper, admin. Пусто означает «всем, кто работает на складе». Слово platform означает «никого не аттестуем» — так помечен раздел для владельца сервиса.
Правка по существу
Под текстом статьи — галочка «Правка по существу — требует переаттестации». Она поднимает редакцию статьи: у всех, кто сдавал по прошлой, зачёт слетает, и в меню повисает запрос перечитать.
Ставьте её, когда изменилось правило, а не формулировка. Исправленная опечатка не повод поднимать на уши весь склад — а вот «теперь дата документа переносит и строки журнала» повод.
Статьи из поставки
Тексты к новым возможностям пишутся вместе с кодом и приезжают вместе с обновлением сервера. Если такие статьи есть, наверху раздела появляется карточка «В поставке есть статьи, которых нет в базе» со списком:
- новая — статьи ещё нет, её можно просто добавить;
- отличается — статья есть, но текст в поставке другой. Перенос заменит ваш текст, поэтому такие отмечены не по умолчанию.
Отметьте нужное и нажмите Перенести отмеченные. Ничего не переносится само: ваши правки важнее.
Что стоит помнить
- Смена кода статьи меняет её адрес. Если на статью где-то ссылались, ссылка перестанет работать.
- Раздел удаляется только пустым: сначала перенесите или удалите его статьи. Перенести статью можно, выбрав другой раздел в поле «Раздел» и сохранив.
- Удаление статьи необратимо — восстановить можно только из резервной копии базы.