Выберите процесс, который требует объяснений
Учебный пример — вымышленный сервис обслуживания офисной техники. Клиент должен понять применимость услуги, подготовить перечень устройств и разобраться, что делать при недостатке сведений. База знаний не принимает техническое решение за инженера и не обещает ремонт любой модели.
Сначала соберите повторяющиеся вопросы из доступных обращений и действующих условий. Персональные данные и частные истории клиентов не нужно переносить в публичный раздел. Используйте обобщённые сценарии после проверки у ответственного за процесс.
Дерево из пяти справочных страниц
Обзор показывает устройство услуги. Подготовка помогает собрать сведения. Ограничения объясняют, когда требуется уточнение. Ошибки помогают исправить неполную заявку. История изменений показывает, какая версия действует. Это разные результаты, поэтому их можно разнести без создания синонимичных статей.
Ниже условные адреса демонстрируют структуру, а не обозначают опубликованный раздел нашего сайта. Дерево читается так: /help/ → обзор; из обзора → подготовка и ограничения; из подготовки → исправление неполной заявки; из любой страницы → действующая версия условий.
| Узел | Учебный путь | Результат |
|---|---|---|
| Обзор | /help/service/ | Понять состав и следующий шаг |
| Подготовка | /help/device-list/ | Собрать перечень техники |
| Ограничения | /help/compatibility/ | Понять необходимость проверки модели |
| Ошибка | /help/missing-model/ | Действовать, если модель неизвестна |
| Версии | /help/changes/ | Найти дату и характер изменения |
Паспорта пяти страниц
Паспорт нужен для редакционного управления. Он называет владельца факта, основание и событие, после которого требуется пересмотр. Это не обязательно отдельный блок для посетителя: публично показывают те сведения о версии и проверке, которые помогают понять действующие условия.
В учебной базе руководитель услуги подтверждает состав, диспетчер — процесс обращения, инженер — ограничения, редактор — согласованность объяснений. Имена реальных экспертов не придумываются; роли описывают необходимое участие.
| Страница | Владелец фактов | Основание | Когда пересматривать |
|---|---|---|---|
| Обзор | Руководитель услуги | Действующее описание состава | Изменился состав обслуживания |
| Подготовка | Диспетчер | Порядок предварительной заявки | Изменились необходимые сведения |
| Ограничения | Ответственный инженер | Подтверждённый перечень применимости | Изменились модели или возможности |
| Модель неизвестна | Диспетчер и инженер | Согласованный альтернативный маршрут | Изменился способ уточнения |
| История изменений | Редактор с владельцем услуги | Журнал утверждённых версий | При публикации новой версии |
Полный пример страницы об ошибке
Вопрос: «Не знаю модель устройства — могу ли отправить заявку?» Учебный ответ: «Для предварительного обращения опишите задачу и укажите место установки. Если модель неизвестна, отметьте это в перечне. Способ уточнения согласует сотрудник сервиса; совместимость и возможность работ подтверждаются после проверки. Не указывайте случайную модель вместо неизвестной».
Этот фрагмент даёт действие и сохраняет границу обещания. Он не требует от человека выполнять опасные манипуляции с оборудованием и не утверждает, что заявка автоматически принята в работу. Если в действующем процессе нужны другие данные, пример заменяют подтверждённой инструкцией.
Страница связывается с общей подготовкой перечня и ограничениями услуги. Ей не требуется повторять весь обзор и историю компании. В конце человек должен знать, что отправить и какое уточнение ждать, а не только увидеть предложение позвонить.
Как не размножить разные версии одного правила
Определите основной источник условия. Например, перечень обязательных данных хранится в инструкции подготовки, а обзор даёт краткое пояснение и ссылку. Если одно правило копируется в пять мест, перечислите эти места в журнале обновления.
Предположим, раньше для предварительного обращения требовалась точная модель, а теперь допустимо отметить её как неизвестную. После согласования нужно проверить подготовку, страницу ошибки и краткое условие в обзоре. Одной новой записи в истории изменений недостаточно, если действующие инструкции продолжают противоречить друг другу.
Не обновляйте дату без содержательной проверки. Дата «проверено сегодня» должна отражать реальное действие. Архивная версия полезна, когда читателю нужно понять прошлое условие, но её нужно ясно отличить от действующей.
| Версия примера | Изменение | Связанные проверки |
|---|---|---|
| v1 | Модель обязательна на первом шаге | Исходный процесс |
| v2 | Неизвестную модель можно обозначить явно | Подготовка, ошибка, обзор |
| Приёмка v2 | Подтверждены альтернативные данные | Нет старого обязательного требования в действующих страницах |
Публичная справка и закрытые сведения
Ответ о составе услуги может быть открытым, а сведения конкретного договора — доступными только авторизованному клиенту. Не нужно открывать закрытый раздел ради поисковой видимости. Чётко определите, какие сведения предназначены неопределённому кругу читателей.
Проверяйте публичные страницы без входа и служебных cookie. Основной ответ должен быть доступен в предусмотренном содержании, а не только сотруднику с особыми правами. Для страниц на JavaScript отдельно проверьте, что получает нужный клиент. Наличие ссылки в дереве не доказывает доступность текста.
Продолжить: Как проверить получение основного текста
Маршрут к услуге и предел самостоятельной помощи
Справка должна позволять завершить простой вопрос самостоятельно. Если нужно уточнение, объясните, когда и с какими данными обращаться. Для учебного сервиса это подготовленный перечень и описание задачи; возможность и стоимость подтверждают в действующем процессе.
Ссылка на услугу сообщает о составе и условиях обращения. Не копируйте цены и обещания в каждую справочную страницу без механизма обновления. И не называйте базу знаний заменой инженера, договора или диагностики, если она только объясняет подготовку.
Продолжить: Как спроектировать переходы между материалами
Приёмка раздела на двух сценариях
Проверьте прямой вход на страницу «модель неизвестна»: человек должен понять действие без чтения всех пяти материалов. Затем начните с обзора и попросите другого сотрудника найти способ подготовки заявки. Так проверяются и самостоятельность страницы, и навигация.
В журнале сохраните найденные противоречия, недоступные адреса, сломанные ссылки и ответственных. После исправления повторите тот же сценарий. Индексирование, цитаты и обращения наблюдают отдельно. Полезная справка помогает читать условия, но не предоставляет автору контроль над внешней выдачей.
Источники: Google: полезный контент