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