Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

Image Added

Общие сведения

Назначение

Информация

Содержит общее описание функциональности, какие основные действия доступны и зачем

Общий алгоритм работы

Информация

Описывается краткий алгоритм работы данной функциональности Что и за чем делать. По сути — это подглавы инструкции

База знаний предназначена для помощи пользователям в решении различных задач. Она содержит руководства и обучающие материалы по продукту. Эти материалы создаются и поддерживаются командой специалистов, которые отвечают за поддержание актуальности и точности предоставляемой информации.

База знаний состоит из разделов, подразделов и статей.

Разделы
Каждый раздел – это последовательный этап работы с Конструктором конкурсов: сначала вы настраиваете профиль,
далее — публичные страницы, затем приступаете к конкурсу и к его этапам. В том же порядке расположены
и разделы базы.

Image Added

Подразделы
Подразделы служат для логической группировки статей внутри раздела. Чтобы открыть содержимое подраздела,
кликните на стрелку слева от названия. Подразделы также отображаются со стрелками у названия
.
Image Added

Статьи
Статья содержит инструкцию по работе с модулями системы. В структуре инструкции обозначены без
стрелки у названия.

Image Added

Easy Dropdown Menu (Status)
set-id4d09d421-61ec-4418-bd23-531f31fa8541
current-option-valueВ РАБОТЕ
option-id236174f2-9e55-47d3-97f4-08f4cc5e9e64

Авторы: 

Easy Dropdown Menu (Status)
set-id55d4c26f-6841-4544-9384-24dfe07c0b11
current-option-valueНЕ УКАЗАНМарьясова Е.
option-idf2ded3056b935ad2-27494ef8-42364eea-994986f9-4317b21df9ca8bc22174e5b8

Последняя редакция:08  

Оглавление:

Оглавление


Доступ

Информация

Описать каким ролям доступна данная функциональность

При необходимости указать, какие ограничения/различия есть у разных ролей

Инструкция

Информация

Содержит описание основных шагов по User story основного пути пользователя. Разбитые на главы, они должна быть краткими, описывать определенный процесс, вид работы.

Используем гифки для отображения действий, чтобы сократить текст и картинки. При этом важно при создании гиф, работать от выдуманного пользователя, НЕ ИСПОЛЬЗУЕМ РЕАЛЬНЫХ ПОЛЬЗОВАТЕЛЕЙ.

Если используем скриншот, то данные затираем. 

Если есть альтернативные алгоритмы работы, то они описываются в отдельной главе с название раскрывающим, что это альтернативный способ

Описание форм

Информация

Описание всех полей, переключателей, кнопок, чек-боксов на странице, если страниц несколько — то по каждой странице, если есть вкладки — то и по каждой вкладке. В структурированной форме в виде таблицы

Поле/ЭлементФорматОписаниеДействия

Проверки и ошибки

Информация

Описание какие проверки происходят и какие возможны ошибки. В виде таблицы: Триггер-Какая проверка-Какие ошибки-Как исправить

ТриггерКакая проверкаКакие ошибкиКак исправить

Инструкция

Чтобы перейти в интересующий вас раздел, наведите на него курсор и нажмите.

Image Added

Если не знаете, в каком разделе находится ответ на ваш вопрос, воспользуйтесь поиском в правом верхнем углу сайта.

Image Added

Напишите любой запрос, система выдаст наиболее точные совпадения по словам.

Image Added

Вы можете найти инструкции соответствующие вашей роли в Конструкторе. Для этого выберите поиск по меткам и напишите ту роль, которая присвоена вам в системе, например "валидатор". Затем поиск выдаст все инструкции для валидаторов.

Image Added

Также вы можете осуществить поиск статей по ролям, перейдя в раздел "Содержание", подраздел "База знаний". На странице отображаются роли, нажав на которые, вы перейдете к статьям, написанным для этих ролей.

Image Added