Легенда оформления статей в Базе знаний
Основные правила
1. Перед созданием статьи анализируем информацию. Отвечаем себе на вопросы:
- О чем статья? На какие вопросы клиента отвечает? Это статья ознакомительная или руководство к действию?
- Какой объем информации мы имеем? Можно ли добавить в имеющиеся статьи или нужно создавать новую?
Таким образом решаем, в какой раздел и категорию Базы знаний мы ее соотнесем.
2. Название статьи должно отображать краткую информацию, о чем статья.
3. Статья должна быть актуальной, отвечать на запросы специалистов.
4. Текст должен быть структурным, понятным, кратким, без грамматических и пунктуационных ошибок.
Проверь текст на ошибки:
- Главред β (glvrd.ru)
- Текстовод (textovod.com)
6. При использовании слеш - специальный значок, выглядящий следующим образом «/» - не используем пробел между словами:
Обмен/возврат.
7. В нижней части статьи добавляем полезную информацию с ссылками на отдельные статьи:
- отделяется горизонтальной линейкой;
- название блока "Полезные статьи" или "Дополнительно полезно".
8. В конце статьи отражаем: дату, ФИО, кто подготовил статью, на основании чего создали или изменили.
Отделить от основного текста двойным межстрочным интервалом.
Пример в конце статьи.
9. Даем проверить оператору на понимание и удобство использования: тому, кто сидит на линии, и тому, кто обрабатывает Usedesk.
10. Добавляем в "Последние новости" с датой создания.
11. Рассказываем о статье в чате и на 5ке всем, просим оценить: поставить «Понравилось» или «Нет».
12. Если статья новая, вопрос по ней используем в ближайшей проверке Айрен.
14. При создании новой статьи на базе существующей необходимо информацию из старой статьи разместить в архив, для этого создается копия статьи. Все изменения вносятся в основную, а копию переносим в архив.
15. В оформлении статьи запрещено использование красного цвета и других цветов, которые не описаны в легенде.
Оформление текста
1. Основной текст
- формат обычный;
- цвет черный, ссылка.
Применяется: основная информация в статьях.
Пример текста: "Стиральная машина производится в г. Набережные Челны".
2. Прямая речь
- формат обычный;
- стиль жирный курсив;
- цвет фиолетовый, ссылка.
Применяется: речевые модули, шаблоны ответов, информация для клиента.
Пример текста: "Благодарю за обращение. Всего доброго".
3. Важный текст для внутреннего пользования
- формат обычный;
- стиль жирный;
- цвет бордовый, ссылка.
Применяется: для привлечения внимания к информации для внутреннего пользования, которая не передаётся клиенту.
Если к тексту нужно привлечь дополнительное внимание, начинаем с фразы: ВАЖНО!
Пример текста: ВАЖНО! СЦ может использовать аналогичную, не заводскую деталь.
3.1 Если к тексту нужно привлечь внимание, но он не настолько значим, как префикс "Важно", используем:
- формат обычный;
- стиль жирный;
- цвет черный.
Пример текста: Жмем «Добавить строку».
3.2 Статусы в Bitrix выделяем оранжевым цветом. Пример
3.3 Статусы тикетов в тексте выделяем в цвете:
- На удержании, В ожидании - шрифт белый, заливка синяя;
- Выполнен - шрифт белый, заливка зелёная.
4. Заголовки, подзаголовки
- название раздела внутри статьи - Заголовок 2. Пример
- подзаголовок внутри статьи - Заголовок 3. Пример
Между основным текстом и подзаголовком делать один пробел. Знаки препинания в конце заголовка или подзаголовка не используются!
5. Перечисление
5.1 Список
- используется инструмент "список".
Применяется: при перечислении пунктов, которым не нужно числовое обозначение.
Пример:
Цвета холодильников Haier:
- белый,
- черный,
- серебристый.
5.2 Нумерация
- формат текста обычный;
- используется инструмент "нумерованный список".
Применяется: при перечислении действий по порядку.
Пример:
- идентифицировать клиента;
- найти заявку;
- добавить комментарий;
- поставить статус.
6. Добавление гиперссылки
- формат текста обычный;
- используется инструмент "гиперссылка";
- текст гиперссылки дублируется с названием статьи.
Применяется: если в текст нужно добавить переход на другую статью.
Пример: Как клиенту добавить установку в заказ смотри в статье "Оформление заказа: Установка стиральной машины".
Оформление таблиц, схем
1. Обозначение активной зоны на скриншотах
1.1 Используем программное приложение Paint 3D.
1.2 Форма - прямоугольник с округлыми краями. Пример.
1.3 Цвета:
- зеленый (код 187319);
- голубой (базовый из раскладки);
- коричневый (код a1582e).
На скрине используем любой цвет из предложенных, но если только фрагменты не соприкасаются друг с другом.
При контакте используем разные цвета, чтобы фигуры не сливались.
Как подобрать цвет:
- в разделе "2D shapes" выбираем нужную форму;
- выделяем фрагмент (сначала будет черным цветом), затем появляется окно выбора цвета;
- нажимаем на окно выбора цвета, затем "+", пример;
- в окне "Hex" вводим код цвета;
- далее цвет сохранится в раскладке.
1.4 Толщина - 4px.
1.5. Толщина цифры зависит от фрагмента, который будет пронумерован.
Рекомендовано от 28-36
2. Таблицы
Заголовок таблицы:
- выравнивание по середине;
- формат обычный;
- стиль жирный;
- цвет черный.
Основной текст:
- выравнивание по левому краю;
- формат обычный;
- цвет черный.
Размеры ячеек устанавливаются автоматически Usedesk.
3. Схемы
3.1 Используем Excel или приложение "Диаграмма".
3.2 Фон схемы белый. Допустима заливка цветом финального результата схемы.
3.3 Стрелки от блока к блоку должны быть направлены на сторону фигуры. Пример верного использования
Не должны быть направлены на угол. Пример неверного использования
3.4 Текст внутри схемы оформляем по логике оформления текста в БЗ (фиолетовый курсив - РМ, жирный бордо - важная информация).
3.5 Статусы тикетов в цвете:
- На удержании, В ожидании - шрифт белый, заливка синяя (0066CC);
- Выполнен - шрифт белый, заливка зелёная (4D9900)
Публикация новостей
1. Дата публикации
- формат текста обычный;
- стиль жирный;
- цвет черный.
2. Основной текст
- формат текста обычный;
- цвет черный;
- для перехода в статью используем гиперссылку.
Пример текста:
Обновлена статья Восстановление чека/Накладная после обмена техники. Необходимо информировать клиента ИМ о возможности выгрузки чека в ЛК или на почте, альтернативой является накладная. Если клиент затрудняется выгрузить чек, не имеет доступа к почте, нет накладной, переводим клиента для консультации на линию ИМ.
3. Перечисление используем, если необходимо отразить несколько изменений по одной статье.
Пример текста:
Обновлена статья Частые вопросы, неисправности ноутбуки Thunderobot. Добавлены ответы на вопросы:
- Почему ограничен функционал BIOS?
- Как открыть расширенный функционал BIOS?
4. Важная информация
- формат текста обычный;
- стиль жирный;
- цвет бордовый;
- выносим текст наверх в отдельный блок с фразой: ВАЖНО!;
- если необходимо подсветить несколько изменений, используем перечисление;
- отделяем информацию горизонтальной линейкой.
Пример текста:
ВАЖНО! В звонке не допускается озвучивать информацию про платный выезд. Сам выезд является частью проверки качества товара в рамках гарантии.
5. Отделяем новости от разных дат горизонтальной линейкой.
29.08.2024 Ольга, Дарья. На основании созвона с Ириной Игриневой по подготовке Базы знаний для группы рекламаций.
04.04.2025 Валиев Р.Р. Добавлена информация о правилах публикации новостей.