Сохраните связь с исходным руководством
Используйте утверждённое руководство как источник и справочный материал, включая ревизию и применимость к моделям. Интерактивный опыт дополняет эту документацию. Обязательные предупреждения и сведения, требуемые законом, должен проверить ответственный за продукт.
Организуйте по задачам
Разделите первоначальную подготовку, повседневное использование, обслуживание, устранение неисправностей и идентификацию деталей. Дайте каждой задаче полезную точку входа вместо размещения всех вопросов в одном неразделённом документе.
Сочетайте форматы без обязательного 3D
Используйте читаемый текст, схемы с обозначениями, клипы и подготовленные интерактивные модели в зависимости от задачи. Правильная плоская иллюстрация может быть полезнее красивой модели, не соответствующей ревизии продукта.
Отвечайте из предоставленных знаний о продукте
Вопросы о продукте требуют применимого источника, модели и задачи. Полезность ассистента зависит от этих материалов. Если источник неполон или противоречив, ответственный за продукт должен устранить пробел перед публикацией.
Запустите одну полезную часть руководства
Первая демонстрация может охватывать одну задачу подготовки или повторяющийся вопрос поддержки. Проверьте её с ответственным за документацию и новым пользователем, затем согласуйте ответственность за обновления и следующие задачи.