Статьи в базе знаний могут относиться к одному из следующих типов:
- Справочные — содержат общую информацию по какой-либо теме.
- Функциональные — описывают последовательность действий для решения какой-либо задачи пользователя.
- Объектно-ориентированные — описывают работу к каким-либо объектом: отчетом, справочником и т. д.
- Связующие — используются для переходов от одного раздела к другому. Как правило содержат набор ссылок.
- Проблема и решение (Troubleshooting) — описывают специфичную проблему или отвечают на часто встречающийся вопрос.
Для каждого типа статьи желательно использовать свой формат наименования. Так пользователь сможет быстрее сориентироваться, где справочная статья, а где — руководство к действию.
Формат наименования нужно зафиксировать в руководстве по стилю. Например, так:
| Тип статей | Формат наименования | Как пишем | Как не пишем |
|---|---|---|---|
| Справочные | О [название темы] | О работе со справочниками | — Как работать со справочниками — Работа со справочниками |
| Функциональные | [Глагольная форма] | Добавление нового клиента | — Как добавить нового клиента — Операции со справочником «Клиенты» |
| Объектно-ориентированные | [Тип объекта] + «[Название объекта]» | Отчет «Клиенты за месяц» | — Клиенты за месяц — Отчет "Клиенты за месяц" |
| Связующие | [Название темы] | Клиенты | — Операции с клиентами — Управление клиентами |
| Проблема и решение | [Суть проблемы в повествовательной форме] | Не выгружается информация о клиентах | — Почему не выгрузились клиенты? — Что делать, если не выгружаются клиенты |
Желательно, чтобы название статьи состояло не более чем из семи слов.
В некоторых случаях допустимо использовать составное название статей, чтобы показать их принадлежность к определенной тематике:
- Структура плана. Разрезы планирования
- Структура плана. Показатели планирования