Преобразование статей справочного центра в руководства по продуктам означает реорганизацию утверждённых ответов вокруг конкретной модели и задачи. Статья может оставаться справочным материалом, а более короткий пошаговый маршрут покажет следующее действие, подходящую иллюстрацию и способ обработки нерешённого вопроса.
Преобразование статей справочного центра в руководства по продуктам означает реорганизацию утверждённых ответов вокруг конкретной модели и задачи. Статья может оставаться справочным материалом, а более короткий пошаговый маршрут покажет следующее действие, подходящую иллюстрацию и способ обработки нерешённого вопроса.
Используйте следующий контекст, чтобы запрос или задачу можно было проверить: URL исходной статьи, применимые модели, редакция статьи, последовательность действий, визуальные материалы, ответственный за контент. Запишите проверенные сведения и неизвестные данные, затем по применимому источнику продукта определите следующий утверждённый шаг.
Выберите статью о сборке, настройке или другом повторяющемся действии клиента. Правила или объяснение общей информации могут оставаться обычным текстом. Отдавайте приоритет материалам, в которых пользователи теряют последовательность, не могут определить нужный компонент или вынуждены переходить между несколькими связанными статьями.
Запишите, какие модели, версии и языки охватывает источник. До объединения устраните противоречия и устаревшие сведения в статьях. Новое руководство должно указывать область применения, чтобы не предлагать один ответ каждому клиенту, который ищет похожий симптом.
Отделите последовательность инструкций от пояснений, предварительных условий и предупреждений. Оставьте ссылку на источник для контекста. Пошаговая инструкция должна говорить, что сделать и как распознать ожидаемый результат, а длинное техническое объяснение может оставаться в утверждённой справочной статье.
Иллюстративный перенос: руководство по продукту объединяет утверждённый перечень деталей, объяснение ориентации и шаг сборки в один маршрут задачи. Ссылки на все источники сохраняются. Проверяющий сверяет общую редакцию продукта, чтобы руководство случайно не сочетало старую соединительную деталь с новейшей последовательностью сборки.
Начните со ссылки на продукт или встроенного руководства для одной утверждённой задачи. Проверьте вход из статьи, страницы продукта и QR-кода, если применимо. Для испытания руководства не нужен перенос всего справочного центра; детали интеграции для выбранной платформы следует согласовать отдельно.
Назначьте тех, кто обновляет статью и созданное на её основе руководство при изменении продукта или источника. Отслеживайте неотвеченные вопросы и несоответствия руководства относительно этой редакции. Измеряйте, доходят ли люди до нужной задачи и завершают ли её, а не только появление новой страницы в базе знаний.
Подготовьте запись о преобразовании статей справочного центра в руководства по продуктам, связывающую источник с реальной задачей. Скопируйте поля контекста ниже в свой процесс работы с продуктом, поддержкой или проверкой. Добавьте ссылку на применимый источник и ответственного, чтобы следующая команда видела, что ещё требует подтверждения.
Запишите URL исходной статьи, применимые модели и редакцию статьи и определите подходящий источник.
Обсудите объём работы на примере публикации рядом с существующим справочным центром, затем с ответственным проверьте реальную задачу и незаполненные поля.
Сохраните последовательность действий, визуальные материалы, ответственного за контент и нерешённый вопрос в полученной записи.
Нет. Начните со статей, объясняющих повторяющееся действие или неоднозначное решение по продукту. Справочная информация и правила могут оставаться читаемыми статьями, на которые ведут ссылки из маршрута задачи.
Используйте URL исходной статьи, применимые модели, редакцию статьи, последовательность действий, визуальные материалы и ответственного за контент. Разделяйте проверенные идентификаторы, наблюдения и нерешённые вопросы, чтобы следующий ответственный мог выбрать подходящий источник.
Отметьте недостающую деталь как неизвестную и явно укажите ответственного за её проверку. Перед ответом по конкретному продукту установите контекст с помощью доступного URL исходной статьи и записей источников.
Предоставьте один продукт и утверждённый источник для повторяющегося вопроса. Целевая демонстрация покажет, как подписанные иллюстрации, проверенные шаги или более ясная запись поддержки помогают работать с URL исходной статьи и применимыми моделями. Перед расширением опыта согласуйте подготовку и проверку.
Отправьте уже имеющиеся утверждённое руководство, схемы или фотографии. Запросите бесплатную демонстрацию руководства, чтобы команда могла оценить одну задачу по продукту перед решением о расширении.
