Как пользоваться руководством
Эта страница объясняет, как устроено руководство и как читать его описания. Прочитайте её один раз.
Четыре части руководства
- Начало работы. Общие сведения: что такое Assist, основные понятия, быстрый старт, устройство интерфейса, вход и роли.
- Процессы. Сквозные инструкции. Каждая отвечает на вопрос «Как сделать X?» и содержит нумерованные шаги, ожидаемый результат и типичные ошибки. Процессы ссылаются на экраны, где выполняется каждый шаг.
- Экраны кабинета. Справочное описание каждой страницы кабинета. Читайте, когда нужно понять, что находится на экране.
- Справочник. Словарь, таблицы прав, стадии, поля, ограничения, сообщения об ошибках, частые вопросы.
Как устроено описание экрана
Описание каждого экрана построено одинаково. Разделы идут в одном порядке, поэтому нужную информацию легко найти.
| Раздел | Что в нём |
|---|---|
| Назначение | Для чего нужен экран, какую задачу он решает |
| Кто видит | Какие роли и права нужны для доступа к экрану |
| Как открыть | Путь через меню и адрес страницы |
| Что на экране | Скриншот с красными номерами и пронумерованный список элементов: что это и что происходит при действии |
| Что можно сделать | Пошаговые инструкции для каждого действия, доступного на экране, поля форм, правила и ограничения |
| Частые вопросы и таблицы ошибок | Тексты сообщений кабинета, причина и способ устранения |
| См. также | Куда перейти дальше |
Если в экране нет соответствующих сведений (например, нет форм или сообщений), раздел не приводится.
Красные номера на скриншотах
На скриншотах отдельные элементы обведены красной рамкой с номером. Номер совпадает с номером пункта в списке «Что на экране» под скриншотом. Так можно найти на картинке любой элемент из описания и, наоборот, понять назначение любого обведённого элемента.
Чтобы рассмотреть скриншот подробнее, нажмите на него: он откроется на весь экран. Повторное нажатие закрывает просмотр.
Условные обозначения
| Обозначение | Значение | Пример |
|---|---|---|
| Жирный текст | Подпись кнопки, вкладки, пункта меню или поля, как она написана в кабинете | Нажмите Создать задачу |
| «Текст в кавычках» | Сообщение кабинета или значение, которое нужно ввести или выбрать | Кабинет покажет «Профиль обновлён» |
Моноширинный текст | Служебное значение: ключ, адрес, имя стадии, код | /projects/20/scope |
| Меню → Пункт | Путь по меню слева | Работа → Проекты |
| Красные цифры на рисунке | Ссылки на пункты списка под скриншотом | См. рисунок, элемент 3 |
Особые блоки внутри текста:
Дополнительное пояснение. Его можно пропустить, но оно помогает понять, как устроена система.
Способ сделать работу быстрее или удобнее.
Действие необратимо или влияет на других людей. Прочитайте блок до выполнения шагов.
Подписи интерфейса и языки
Кабинет имеет два языка интерфейса: русский и английский. Переключатель EN / RU находится в шапке кабинета, выбор запоминается в браузере. Русская версия руководства использует подписи русского интерфейса. Английская версия использует подписи английского интерфейса и английские скриншоты. Переключатель языка руководства находится в правом верхнем углу сайта.
Названия проектов, задач, людей и значения полей не переводятся: это ваши данные, а не интерфейс.
Адреса страниц
Адрес страницы указывается относительно адреса вашего кабинета. Например, адрес /tasks означает страницу «Задачи» по адресу https://<адрес кабинета>/tasks. Адреса нужны, чтобы отправить коллеге ссылку на страницу и чтобы найти страницу по закладке в браузере.
Права доступа
Меню и вкладки кабинета зависят от роли. Для каждого экрана в руководстве указано, какое право нужно для доступа. Если нужного пункта нет в вашем меню, у вашей роли нет такого права. Подробно: «Роли и доступ» и таблица прав.
Как искать информацию
- Нужно сделать что-то конкретное. Откройте раздел «Процессы» и найдите инструкцию по названию задачи.
- Нужно понять незнакомый экран. Откройте раздел «Экраны кабинета» и найдите страницу в боковом меню сайта или в карте меню.
- Встретилось незнакомое слово. Найдите его в словаре.
- Кабинет показал сообщение. Найдите текст в списке сообщений.
- Поиск по сайту. Используйте поиск браузера (Ctrl+F или ⌘+F) на странице нужного раздела.