История страницы
Общие сведения
Назначение
| Информация |
|---|
Содержит общее описание функциональности, какие основные действия доступны и зачем |
Общий алгоритм работы
База знаний предназначена для помощи пользователям в решении различных задач. Она содержит руководства и обучающие материалы по продукту. Эти материалы создаются и поддерживаются командой специалистов, которые отвечают за поддержание актуальности и точности предоставляемой информации.
Easy Dropdown Menu (Status) set-id 4d09d421-61ec-4418-bd23-531f31fa8541 current-option-value В РАБОТЕ option-id 236174f2-9e55-47d3-97f4-08f4cc5e9e64
Авторы: Easy Dropdown Menu (Status) set-id 55d4c26f-6841-4544-9384-24dfe07c0b11 current-option-value НЕ УКАЗАН option-id f2ded305-2749-4236-9949-4317b21df9ca
Последняя редакция:08
Оглавление:
Оглавление
Доступ
| Информация |
|---|
Описать каким ролям доступна данная функциональность При необходимости указать, какие ограничения/различия есть у разных ролей |
Инструкция
Содержит описание основных шагов по User story основного пути пользователя. Разбитые на главы, они должна быть краткими, описывать определенный процесс, вид работы.
Используем гифки для отображения действий, чтобы сократить текст и картинки. При этом важно при создании гиф, работать от выдуманного пользователя, НЕ ИСПОЛЬЗУЕМ РЕАЛЬНЫХ ПОЛЬЗОВАТЕЛЕЙ.
Если используем скриншот, то данные затираем.
Если есть альтернативные алгоритмы работы, то они описываются в отдельной главе с название раскрывающим, что это альтернативный способИнструкция
База знаний состоит из разделов, подразделов и статей.
Разделы
Каждый раздел – это последовательный этап работы с Конструктором конкурсов: сначала вы настраиваете профиль,
далее — публичные страницы, затем приступаете к конкурсу и к его этапам. В том же порядке расположены
и разделы базы.
Подразделы
Подразделы служат для логической группировки статей внутри раздела. Чтобы открыть содержимое подраздела,
кликните на стрелку слева от названия. Подразделы также отображаются со стрелками у названия.
Статьи
Статья содержит инструкцию по работе с модулями системы. В структуре инструкции обозначены без
стрелки у названия.
Переходите в раздел, по которому у вас есть вопрос. Если не знаете, к какому разделу относится вопрос,
воспользуйтесь поиском в правом верхнем углу.
Пишите любой запрос, система выдаст наиболее точные совпадения по словам.
Ищите инструкции, соответствующие вашей роли в Конструкторе. Например, для роли
Валидатор в разделе Фильтровать по выберите поиск по меткам и напишите
«валидатор». Система выдаст все инструкции для валидаторов.
Описание форм
| Информация |
|---|
Описание всех полей, переключателей, кнопок, чек-боксов на странице, если страниц несколько — то по каждой странице, если есть вкладки — то и по каждой вкладке. В структурированной форме в виде таблицы |
| Поле/Элемент | Формат | Описание | Действия |
|---|---|---|---|
Проверки и ошибки
| Информация |
|---|
Описание какие проверки происходят и какие возможны ошибки. В виде таблицы: Триггер-Какая проверка-Какие ошибки-Как исправить |
| Триггер | Какая проверка | Какие ошибки | Как исправить |
|---|---|---|---|