Одит на прехода от ръководство към интерактивен наръчник: изберете задача за преглед
Използвайте този одит, за да решите кое съдържание от ръководството е подходящо за първа интерактивна задача и каква подготовка остава. Запишете източника, въпроса на клиента, нуждата от визуални материали и отговорника за прегледа, преди да изберете между ръководство, по-ясна статия или актуализация на източника.
Опишете задачата и повтарящия се въпросПроверете приложимия източникПример: справочната глава не е първото ръководство
Проблем
С какво ви помага този процес
Използвайте този одит, за да решите кое съдържание от ръководството е подходящо за първа интерактивна задача и каква подготовка остава. Запишете източника, въпроса на клиента, нуждата от визуални материали и отговорника за прегледа, преди да изберете между ръководство, по-ясна статия или актуализация на източника.
Използвайте следния контекст, за да може заявката или задачата да бъде прегледана: продукт и редакция, раздел от ръководството, повтарящ се въпрос, решение за визуализация, пропуски в източника, отговорник за прегледа. Запишете кое е проверено и кое остава неизвестно, след което използвайте приложимия продуктов източник, за да определите следващата одобрена стъпка.
ИЗПОЛЗВАЙТЕ ИНСТРУМЕНТА
Подгответе одит от ръководство към насоки
Опишете една кандидат-задача. Формулярът създава обобщение за планиране от въведените данни; не анализира и не качва PDF.
Практически насоки
Изпълнете задачата с правилния контекст.
Опишете задачата и повтарящия се въпрос
Изберете действие или решение, с което потребителите многократно се затрудняват. Запишете доказателствата за избора, например запитване към поддръжката или наблюдавана грешка при сглобяване. Тема, която просто заема много страници в ръководството, може да не е най-полезната за първо интерактивно ръководство.
Продукт и редакция
Раздел от ръководството
Повтарящ се въпрос
Проверете приложимия източник
Запишете продукта, редакцията на ръководството и съответния раздел. Посочете липсващите предварителни условия, неясните стойности или противоречивите препратки към части. Това са въпроси за преглед на източника, а не възможност автоматичното създаване да измисли цялостна процедура.
Решение за визуализация
Пропуски в източника
Отговорник за прегледа
Обяснете защо е нужна визуализация
Посочете кое решение е трудно да се вземе само по текст: ориентация, скрита връзка, идентичност на компонент или важно движение. Налична диаграма с означения може да реши задача за справка. Използвайте 3D изглед или анимация, когато избраната задача действително го изисква.
Подгответе резултат, който може да бъде прегледан
Инструментът подрежда задачата, източника, нуждата от визуални материали и отговорника в обобщение за одит, което можете да копирате. Той не прочита ръководство и не извлича автоматично стъпки. Прегледайте обобщението с експерта по темата, за да решите кое съдържание и кои материали трябва да бъдат подготвени.
Пример: справочната глава не е първото ръководство
Илюстративен одит: подробна глава със спецификации остава свързан справочен материал, а повтарящ се въпрос за ориентацията на панел става кандидат за първо ръководство. Задачата има приложим източник и наблюдаем резултат. Одитът запазва полезността и на двата вида съдържание, без да налага превръщането на целия PDF в поредица от стъпки.
Посочете ясно следващото действие
Решете дали да изясните източник, да подготвите визуален материал, да прегледате чернова или да запазите формата на статия. Определете отговорник и въпрос за приемане на пилотния проект. Подреждането на съдържанието според практическото следващо действие е по-полезно от обявяването на всеки раздел от ръководството за готов за преобразуване.
Полета за следващия ви запис
Подгответе запис за одит на прехода от ръководство към интерактивен наръчник, като изберете задача за преглед, която свързва източника с действителното действие. Копирайте полетата за контекст по-долу във вашия процес за продукт, поддръжка или преглед. Добавете приложимия източник и отговорното лице, за да може следващият екип да види какво още трябва да бъде потвърдено.
Продукт и редакция
Раздел от ръководството
Повтарящ се въпрос
Решение за визуализация
Пропуски в източника
Отговорник за прегледа
Работен процес
Използвайте инструмента и прегледайте резултата
01
Определете контекста
Запишете продукта и редакцията, раздела от ръководството, повтарящия се въпрос и посочете приложимия източник.
02
Прегледайте една задача
Обсъдете обхвата с примера, при който справочната глава не е първото ръководство, след което прегледайте действителната задача и непопълнените полета с отговорното лице.
03
Проверете следващото предаване
Включете в записа решението за визуализация, пропуските в източника, отговорника за прегледа и нерешения въпрос.
Често задавани въпроси
Въпроси за тази задача.
Извлича ли този одит автоматично съдържание от PDF?
Не. Той създава обобщение за планиране въз основа на въведената от вас информация. Извличането на данни от действителния източник, подготовката на визуални материали и прегледът от отговорника за продукта са отделни задачи.
Кои полета трябва да включва записът?
Използвайте продукт и редакция, раздел от ръководството, повтарящ се въпрос, решение за визуализация, пропуски в източника и отговорник за прегледа. Разграничавайте проверените идентификатори, наблюденията и нерешените въпроси, за да може следващият отговорник да избере приложимия източник.
Как да постъпя с неизвестна подробност за продукта?
Отбележете липсващата подробност като неизвестна и посочете кой отговаря за проверката ѝ. Използвайте наличните данни за продукта и редакцията и записите за източника, за да установите контекста, преди да дадете отговор за конкретен продукт.
Как Viflux може да помогне в този процес?
Предоставете един продукт и одобрения източник за повтарящ се въпрос. Целенасочена демонстрация може да покаже как обозначени визуални материали, прегледани стъпки или по-ясен запис за поддръжката помагат с продукта, редакцията и раздела от ръководството. Уточнете подготовката и прегледа, преди да разширите проекта.
Започнете с един продукт и един повтарящ се въпрос
Изпратете одобреното ръководство, диаграмите или снимките, с които вече разполагате. Поискайте безплатна демонстрация на ръководство, за да прегледа екипът ви една задача за даден продукт, преди да решите как да разширите проекта.
Един продукт и приложимата му редакцияСъществуваща одобрена документацияЕдна задача или повтарящ се въпрос към поддръжката