Skip to content

Справка для сотрудников ​

Справка «Как сделать» — короткие пошаговые статьи для сотрудников (не для разработчиков): как поставить задачу, сдать часы, оформить командировку, составить смету и т. д. Её читают три места:

  • кнопка «Справка» в правой панели над «Новым сообщением» (и в её шапке, и в меню профиля) — боковая панель со статьями, привязанными к текущему экрану; для экрана статей нет — «Начало работы»;
  • страница «Справка» (/help, из панели и меню профиля) — статьи по разделам, фильтр «Для меня / Все статьи», поиск по словам;
  • AI-помощник — инструмент help: на вопросы «как сделать / где найти» он ищет статью, читает её и пересказывает шаги со ссылкой на статью.

Рядом — кнопка «Тур по экрану»: несколько шагов с подсветкой «что здесь где». Сам тур не всплывает, вызывается сколько угодно раз. На основных экранах тур свой (задачи, проекты, карточка проекта, компании и карточка, контакты, оборудование, логистика, командировки, табель, платежи, чаты), на остальных — общий по шапке и меню. Туры описаны во фронте (useAppTour); цели — части дизайн-системы (.app-page__actions, фильтры, таблица, вкладки), шаг без цели на экране пропускается.

Где лежат статьи ​

internal/modules/help/articles/<раздел>/<slug>.md, вшиты в бинарник (embed). Поправить текст — обычный коммит: без миграций и админки.

---
title: Как оформить командировку
section: trips
audience: all
screens: /trips
order: 10
summary: Одна фраза — о чём статья.
---

Абзац: зачем и кто это делает.

## Как сделать

1. Откройте «Командировки» в меню слева.
2. ...

## Полезно знать

- ...
  • section — раздел (start, tasks, timesheet, chats, projects, crm, warehouse, trips, finance, lead, admin), совпадает с папкой.
  • audience — кому обычно нужна статья: all, employee, manager, warehouse, finance, executive, admin. «Для меня» показывает статьи роли сотрудника (по его главной) и all; администратору — ещё admin.
  • screens — шаблоны путей приложения (/projects/:id); шаблон без параметра в конце покрывает и вложенные адреса.
  • Ссылки на статьи — [текст](help:slug), на экраны — [Задачи](/tasks).

Названия кнопок и полей в статьях — ровно как в интерфейсе. Переименовали кнопку — поправьте статьи (grep -r "«Старое название»" internal/modules/help/articles).

Тест пакета разбирает все статьи и проверяет ссылки между ними: опечатка в заголовке или ссылка на несуществующую статью валит CI, а не справку.

API ​

МетодЧто
GET /api/v1/help/sectionsразделы в порядке показа
GET /api/v1/help/articlesстатьи без текста; q — поиск, section, audience, screen
GET /api/v1/help/articles/:slugстатья целиком, body — Markdown

Читает любой вошедший сотрудник. Поиск — по словам без окончаний («командировку» находит «командировка»), совпадения в заголовке весят больше, чем в тексте; статья, где совпали все слова запроса, выше.

Загружаем документацию…