Урок 3. Как создать и оформить статью
- Шаг 1. Откройте нужный раздел Базы знаний
- Шаг 2. Создайте статью
- Шаг 3. Используйте панель инструментов редактора
- Шаг 4. Оформите структуру статьи через заголовки
- Шаг 5. Добавьте кросс-ссылки на другие статьи
- Шаг 6. Создайте якоря и оформите оглавление статьи
- Шаг 7. Добавьте изображение в статью
- Шаг 8. Настройте скачивание статьи в PDF через печатную форму
Статья в Базе знаний — это инструкция, регламент, описание типового решения или внутренний документ, к которому сотрудники и заявители должны быстро получать доступ. Чем понятнее оформлена статья, тем проще сотрудникам находить нужную информацию и использовать ее в работе с заявками. В этом уроке создадим статью, оформим структуру, добавим ссылки, вложения и навигацию внутри материала.
Шаг 1. Откройте нужный раздел Базы знаний
Откройте раздел Базы знаний, в котором должна храниться статья. При необходимости перейдите во вложенный подраздел. Теперь создадим новую статью внутри раздела.
Шаг 2. Создайте статью
Нажмите кнопку создания статьи.
Укажите:
- название статьи;
- раздел, куда будет вложена статья.
Название статьи должно сразу объяснять, какую задачу она помогает решить.
Хорошо Плохо Как подключить кассу Атол Инструкция №5 Что делать, если оборудование не выходит в сеть Настройка Как оформить возврат оборудования Важно
После создания статьи оформим текст и познакомимся с панелью инструментов редактора.Шаг 3. Используйте панель инструментов редактора
Откройте редактор статьи и посмотрите доступные инструменты оформления. Используйте кнопки панели для форматирования текста и структуры статьи.
Кнопка Для чего используется Жирный текст Выделяет важные фрагменты текста Курсив Используется для акцентов или пояснений Подчеркивание Подчеркивает текст Удаление форматирования Возвращает текст в исходный формат Выравнивание Выравнивает текст по левому краю, центру или правому краю Изображение Добавляет изображение в статью Таблица Создает таблицу внутри статьи Ссылка Добавляет ссылку Якорь Создает якорь для навигации внутри статьи Нумерованный список Создает список с нумерацией Маркированный список Создает список с точками Шрифт Позволяет выбрать шрифт текста Размер текста Изменяет размер текста Полноэкранный режим Открывает редактор на весь экран Источник Это продвинутый режим редактирования для пользователей, которым нужно вручную управлять структурой и оформлением материала. В этом режиме можно редактировать заголовки, таблицы, якоря, HTML-разметку и другие элементы статьи.
Большую часть оформления можно выполнять через панель инструментов без ручного редактирования HTML. Режим «Источник» обычно используют для более точной настройки структуры или нестандартного оформления статьи.
Теперь оформим структуру статьи с помощью заголовков.Шаг 4. Оформите структуру статьи через заголовки
Заголовки помогают разделить материал на логические блоки и сделать статью удобнее для чтения. Выделите текст и в списке «Форматирование» выберите нужный уровень заголовка.
Формат Использование Пример Заголовок 2 Основные разделы статьи Подключение кассы Заголовок 3 Подразделы и отдельные шаги Шаг 1. Укажите модель кассы Заголовок 4 Дополнительные пояснения внутри разделов Особенности подключения через Wi-Fi Обычное Основной текст статьи Описание действий и пояснения После выбора формата редактор автоматически изменит оформление текста. Заголовки станут крупнее, появятся отступы, а статья будет выглядеть более структурированной.
Используйте заголовки во всех длинных инструкциях, регламентах и технической документации. Благодаря им материал легче читать, нужную информацию проще находить, а в дальнейшем на основе заголовков можно создать оглавление статьи.
Теперь свяжем статью с другими материалами Базы знаний.
Шаг 5. Добавьте кросс-ссылки на другие статьи
Перед текстом, который должен вести на другую статью введите символ "@" и выберите в окне нужный материал, сохраните изменения. Проверьте переход по ссылке после сохранения статьи.
Кросс-ссылки помогают:
- объединять связанные инструкции;
- быстрее переходить между материалами;
- не дублировать одинаковую информацию в разных статьях.
Например, из инструкции по настройке кассы можно перейти к статье по обновлению прошивки. Дальше создадим навигацию внутри статьи.
Шаг 6. Создайте якоря и оформите оглавление статьи
Якоря помогают быстро переходить к нужным разделам длинной статьи. На их основе можно создать кликабельное оглавление с навигацией по инструкции.
6.1. Создание якоря в статье
Установите курсор в начало заголовка или раздела, к которому должен вести переход. Нажмите кнопку с флажком на панели инструментов редактора. В открывшемся окне укажите имя якоря. Используйте короткие и понятные названия. Сохраните якорь.
После создания якоря в тексте появится красный флажок — это обозначение точки перехода внутри статьи.
Повторите действие для остальных разделов инструкции. Якоря используются как точки навигации внутри статьи. Позже их можно будет использовать для создания оглавления и быстрых переходов между разделами.
6.2. Создание оглавления статьи
В начале статьи добавьте список разделов, к которым нужен быстрый переход.
Например:
- Подготовка оборудования.
- Подключение кассы.
- Проверка подключения.
- Что делать при ошибке.
Выделите название раздела в оглавлении и нажмите кнопку добавления ссылки. В поле «Тип ссылки» выберите: «Ссылка на якорь в тексте».
После этого в выпадающем списке появятся созданные якоря. Выберите нужный якорь и сохраните ссылку.
Повторите действие для остальных пунктов оглавления. После сохранения статьи названия разделов станут кликабельными. При нажатии пользователь будет сразу переходить к нужному блоку инструкции.
Кликабельное оглавление особенно удобно для:
- длинных инструкций;
- регламентов;
- технической документации;
- клиентских инструкций с большим количеством шагов.
Так пользователю не нужно вручную искать нужный раздел по тексту статьи. Дальше настроим возможность скачивать статьи из Базы знаний.
Шаг 7. Добавьте изображение в статью
Изображения помогают сделать инструкцию понятнее. В статьях Базы знаний можно добавлять фотографии оборудования, схемы, скриншоты интерфейсов и другие материалы.
- Чтобы добавить изображение:
- Откройте статью в режиме редактирования.
- Установите курсор в место, куда нужно вставить изображение.
- Нажмите на кнопку «Изображение» на панели редактора.
- В открывшемся окне перейдите на вкладку «Загрузить».
- Нажмите на кнопку «Выберите файл».
- Выберите изображение на компьютере.
- Нажмите на кнопку «Загрузить на сервер».
- После загрузки откройте вкладку «Данные об изображении».
- При необходимости укажите ширину, высоту, выравнивание изображения.
- Нажмите на кнопку «ОК».
Изображения можно использовать для:
- фотографий оборудования;
- схем подключения;
- примеров неисправностей;
- скриншотов интерфейсов;
- визуальных инструкций для сотрудников и заявителей.
Шаг 8. Настройте скачивание статьи в PDF через печатную форму
Статьи Базы знаний можно выгружать в PDF через механизм печатных форм. Это удобно, когда инструкцию нужно:
- отправить заявителю;
- распечатать;
- сохранить локально;
- приложить к документации или заявке.
Чтобы вкладка «Печатные формы» появилась внутри статьи Базы знаний, сначала нужно создать отдельную печатную форму с привязкой к объекту «Статья Базы знаний».
8.1. Создайте печатную форму
Перейдите в раздел «Настройки» → «Печатные формы». Нажмите на кнопку «Добавить». В открывшемся окне укажите:
- название шаблона;
- формат листа;
- привязку к объекту - «Статья Базы знаний».
Ниже выберите роли, которым будет доступна работа с этой печатной формой. После заполнения параметров нажмите на кнопку «Создать».
8.2. Добавьте контекстную переменную статьи
После создания шаблона откройте его из списка печатных форм. Нажмите на название формы. Затем нажмите иконку карандаша рядом с текстом шаблона и откройте редактор содержимого.
Добавьте контекстную переменную:{{{ARTICLE.CONTENT}}}
Эта переменная подставляет текст статьи Базы знаний в PDF-документ.
После сохранения шаблона печатная форма автоматически станет доступна внутри статей Базы знаний. Подробнее о настройке печатных форм см. в документации.
8.3. Скачайте статью в PDF
После настройки печатной формы внутри статьи появится вкладка «Печатные формы». Нажмите на название печатной формы, чтобы открыть предварительный просмотр документа.
Скачать PDF можно:
- через иконку скачивания в списке печатных форм;
- или прямо из окна предварительного просмотра.
Когда вы нажмете на кнопку «Сохранить на диске» платформа подготовит PDF-файл, который можно скачать и использовать как отдельный документ.
В следующем уроке разберем, как настроить права доступа к Базе знаний для сотрудников, заявителей и отдельных разделов.
Загрузка данных...