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