Оформление
Подготовить и отредактировать статью
Редактирование базы знаний доступно пользователям с правами на соответствующую область и раздел. Право читать статью не означает право её изменять.
Подготовить материал
В рабочем месте откройте базу знаний и выберите нужную область и раздел. Над содержимым выбранного раздела нажмите «+ Статья» — откроется окно «Новая статья». Если кнопка недоступна, у вас может не быть права создания в этом разделе.
Чтобы изменить существующую статью, откройте её карточку и нажмите доступное действие «Редактировать». В окне «Редактирование статьи» проверьте название и текст. Дополнительные поля зависят от настроенной формы.
Сформулируйте заголовок как задачу читателя: «Подключиться к учебному сервису», а не «Разное». В начале кратко объясните, кому и когда нужна инструкция.
Создать раздел и настроить информацию
В корне выбранной базы знаний нажмите «+ Добавить раздел», а внутри раздела — «+ Подраздел». Заполните предложенную форму и сохраните. Раздел объединяет материалы; это не статья с пустым текстом.
У существующего раздела откройте «Информация» → «Редактировать». Здесь можно изменить доступные сведения, вручную выбрать ответственного и дополнительные роли раздела. Роли родителя наследуются, выбранные роли дополняют их. Ответственный сам по себе не получает все права редактирования; это отдельная настройка от ролей.
Перед добавлением роли проверьте, кому откроются материалы раздела. Не переносите внутреннюю инструкцию в пользовательскую область ради обхода доступа.
Написать понятную инструкцию
- Укажите, что нужно подготовить до начала.
- Разбейте действия на короткие нумерованные шаги.
- Приводите точные подписи кнопок и полей.
- После шагов объясните ожидаемый результат.
- Добавьте ограничения и способ обратиться за помощью.
Вложения и изображения должны помогать действию. Не добавляйте снимок всего экрана, если для шага достаточно небольшой области.
Сохранить и проверить
Нажмите «Сохранить черновик». Система сохранит редакцию и закроет окно редактора. Если карточка сообщает о неопубликованной редакции, это ещё не опубликованный текст для читателей.
Откройте сохранённое содержание, проверьте ссылки, форматирование и отсутствие личных данных. Только после этого переходите к публикации.
Пример: от новой статьи к читателю
На учебном стенде редактор Ирина открыла База знаний → Пользовательская БЗ → Работа с компьютером → + Статья. У неё есть право управления БЗ; это не вход суперпользователем.
- В поле «Название» ввела «Что проверить, если компьютер не включается».
- В «Текст статьи» написала короткие шаги проверки и обращения в поддержку. При необходимости используйте кнопки редактора для списка, ссылки, таблицы или изображения.
- Нажала «Сохранить черновик». Открылась карточка с жёлтой пометкой «Изменения ещё не опубликованы». Это нормальный промежуточный результат: читателю материал ещё не выдан.
- Проверила содержание и нажала «Опубликовать». Пометка черновика исчезла, появились действия опубликованной статьи.
- Для контрольной проверки вошла отдельной учебной учётной записью читателя Марии: База знаний → Работа с компьютером → название статьи. Мария увидела текст, но не кнопки редактирования и публикации.
Если читатель не видит статью, проверьте область БЗ, публикацию и роли раздела. Не выдавайте административную роль только ради чтения.
Совместное редактирование
Если редакция изменилась, обновите карточку и сопоставьте изменения. Не повторяйте публикацию старой версии без проверки.