Как пользоваться порталом
Короткие руководства по работе с порталом для каждой роли.
Сотруднику: чтение и примечания
Сотруднику: как читать инструкции и оставлять примечания
Коротко
- Портал — единое место, где лежат актуальные инструкции компании.
- Вы читаете инструкции и можете оставить примечание к любому месту текста.
- Сам текст инструкций сотрудники не меняют — это делает владелец инструкции.
Как войти
Откройте адрес портала в браузере и войдите по учётным данным, которые дал руководитель или администратор. Если входа нет — напишите администратору.
Как найти нужную инструкцию
- Вверху — меню «Разделы» (направления) и «Инструкции» (конкретные инструкции).
- Либо воспользуйтесь строкой «Поиск» вверху — ищет по всему тексту.
- Внутри инструкции слева — список разделов («Навигация по инструкции»).
Как оставить примечание к тексту
- Выделите мышкой фрагмент текста, к которому есть вопрос или замечание.
- Рядом появится значок комментария — нажмите его.
- Напишите примечание и сохраните.
Можно оставить и общее примечание к разделу: внизу страницы кнопка «Комментировать».
Что будет дальше
Владелец инструкции увидит ваше примечание, рассмотрит его и примет или отклонит. Принятые правки вносятся в текст, и примечание уходит в архив. Следить за статусом не нужно — изменения появятся в самой инструкции.
Видео
К некоторым шагам есть видео (раздел «Видеоуроки» и ссылки прямо в шагах) — удобно посмотреть, как действие выглядит в системе.
Владельцу инструкции: утверждение правок
Владельцу инструкции: как утверждать правки
Кто такой владелец инструкции
Сотрудник, который отвечает за содержание конкретной инструкции и решает, какие замечания принять. У каждой инструкции есть свой владелец.
Как это выглядит
Под каждым примечанием сотрудников вам (и только вам) видны кнопки «Принять» и «Отклонить» и поле «уточнение» рядом. Обычные читатели этих кнопок не видят.
Как принять или отклонить
- Прочитайте примечание.
- Если согласны — при желании впишите уточнение в поле рядом (например, «применить, но формулировку смягчить») и нажмите «Принять».
- Если не согласны — нажмите «Отклонить» (уточнение-причину тоже можно вписать).
Решение можно принять двумя способами:
- в списке примечаний внизу страницы;
- во всплывающем окне у самого текста — кликните по метке «Ссылка» или по значку комментария у фрагмента. Если кнопок не видно — прокрутите окно вниз, они под текстом примечания.
Что происходит после «Принять»
Правка вносится в текст инструкции (с сохранением прежней версии), примечание уходит в «Архивировано», а в ветке появляется отметка «Готово» с пояснением, что сделано. Правки применяются по расписанию (или по запросу), поэтому изменение может появиться не мгновенно.
Если нужно поправить текст самому
Владелец (и редактор) может изменить текст и напрямую — кнопка «Редактировать» вверху страницы. Все версии сохраняются в разделе «Версии», откуда можно откатиться.
Важно
- Решение принимает владелец инструкции; примечания сотрудников — это предложения.
- Спорные или противоречивые замечания лучше сначала обсудить, а потом принимать.
Администратору портала
Администратору портала: пользователи, права, структура
Доступ к управлению
Всё управление — под значком «Настройки» (шестерёнка) вверху справа.
Пользователи
Настройки → Пользователи → Создать пользователя. Укажите имя, email и роль. Новому сотруднику передайте адрес портала и данные для входа.
Роли и права
- Viewer — читатели: видят инструкции и могут оставлять примечания, но не меняют текст. Это роль для большинства сотрудников.
- Editor — могут редактировать текст инструкций.
- Admin — полный доступ: пользователи, права, настройки.
- Public — гостевой доступ (если включён публичный просмотр).
Роль назначается пользователю в его карточке. Права можно тонко настроить в Настройки → Роли.
Кто владелец инструкции
Владелец инструкции (тот, чьи решения «Принять/Отклонить» учитываются) задаётся в настройке портала отдельно. По умолчанию — главный администратор; чтобы назначить другого человека по конкретной инструкции, сообщите об этом — настройка правится централизованно.
Структура портала
Три уровня:
- Полка (в меню «Разделы») — направление или участок.
- Инструкция (книга) — одна инструкция с кодом (ПО-01, УК-01…).
- Раздел (страница) — часть инструкции.
Создаются через «Создать» в соответствующем разделе. Инструкцию можно привязать к полке.
Обложки
Чтобы плашка не была пустой: откройте инструкцию или полку → «Редактировать» → загрузите изображение-обложку.
Резервные копии и история
BookStack хранит все версии каждой страницы («Версии»). Дополнительно тексты инструкций резервируются отдельными файлами на Synology.
Доступ для автоматизации
Для автоматической обработки правок используется API-токен (профиль администратора → «Доступ и безопасность» → «Токены API»). Храните секрет токена в надёжном месте.