Документацията на машини по поръчка трябва да отразява машината, доставена на конкретния клиент. Насочваното преживяване е полезно, когато запазва действително изработената конфигурация, имената на станциите и одобрените процедури, вместо да заимства инструкции от подобен стандартен продукт.
Документацията на машини по поръчка трябва да отразява машината, доставена на конкретния клиент. Насочваното преживяване е полезно, когато запазва действително изработената конфигурация, имената на станциите и одобрените процедури, вместо да заимства инструкции от подобен стандартен продукт.
Използвайте следния контекст, за да може заявката или задачата да бъде проверена: проект и сериен номер на машината, ревизия на действителното изпълнение, монтирани станции, изменения за клиента, отговорник за задачата и одобрен приемателен протокол. Запишете какво е проверено и какво остава неизвестно, след което използвайте приложимия източник за продукта, за да определите следващата одобрена стъпка.
Определете проекта, серийния номер на машината и доставената конфигурация. Свържете измененията за конкретния клиент и одобрените ревизии на документите с този запис. Ръководството за стандартното продуктово семейство може да предостави обща информация, но не бива незабелязано да замества инструкциите за машина, изработена с различни станции или опции.
Използвайте имената на станциите, които операторите и сервизните екипи действително употребяват на място. Свържете всяка станция с нейните изходни чертежи, органи за управление и процедура. Обозначен общ изглед може да намали неяснотата, когато клиентът казва, че вторият модул не работи, но производителят използва друг номер на станция.
Определете дали задачата принадлежи на оператора, екипа за техническо обслужване, интегратора или производителя на машината. Запазете документираните предпоставки и отговорника за ескалацията. Ръководството не бива да прехвърля на клиента специализирано решение за пускане в експлоатация само защото стъпките могат да се покажат в браузър.
Илюстративен случай при създаване на съдържание: производителят записва опционалната станция за проверка в конфигурацията на клиента. Нейното ръководство се появява само в картата на задачите на тази машина. Операторите на друго изпълнение не получават стъпки за възел, който никога не е бил монтиран.
Запишете влиянието на изменение върху чертежите, референциите на части, информацията за управление и свързаните процедури. Прегледайте свързаните ръководства преди повторно публикуване. Съхраняването на предишната одобрена ревизия позволява на поддръжката да разбере дали съобщено несъответствие идва от остаряла документация или от недокументирана промяна на място.
Изберете една задача с одобрена последователност и ясен запис за завършване. Прегледайте я с производителя и екипа на клиента, който я изпълнява. Измервайте дали ръководството установява правилната конфигурация и предаване, вместо да приемате клиентската приемка като последица от преглеждането на инструкциите.
Подгответе запис за интерактивна документация на машини по поръчка, който свързва източника с действителната задача. Копирайте полетата за контекст по-долу в собствения си процес за продукт, поддръжка или преглед. Добавете приложимата препратка към източника и отговорното лице, за да вижда следващият екип какво още трябва да бъде потвърдено.
Запишете проекта и серийния номер на машината, ревизията на действителното изпълнение и монтираните станции и определете приложимия източник.
Използвайте сценария за отразяване на промените в библиотеката с ръководства, за да обсъдите обхвата, след което прегледайте действителната задача и непопълнените полета с отговорното лице.
Съхранявайте измененията за клиента, отговорника за задачата, одобрения приемателен протокол и неразрешения въпрос заедно с получения запис.
Многократно използваемите стъпки могат да улеснят създаването на съдържание, но производителят трябва да провери дали се отнасят за доставената конфигурация. Опционалните станции, измененията и специфичните за клиента изисквания за приемане се нуждаят от собствен контекст на източника.
Започнете с приложимата документация и наличните визуални материали, както и с проекта и серийния номер на машината, ревизията на действителното изпълнение и монтираните станции. Изберете един повтарящ се въпрос и помолете отговорното лице за продукта да прегледа съответния източник, преди да разширите ръководството.
Това е илюстративен сценарий за създаване на съдържание или поддръжка, а не клиентски казус или измерен резултат. Използвайте го, за да обсъдите необходимия продуктов контекст и да проверите действителната задача с отговорника на източника.
Представете един продукт и одобрения източник за повтарящ се въпрос. Целенасочена демонстрация може да покаже как обозначени визуални материали, проверени стъпки или по-ясен запис за поддръжка помагат с проекта и серийния номер на машината и ревизията на действителното изпълнение. Уточнете подготовката и прегледа, преди да разширите преживяването.
Изпратете одобрения наръчник, схемите или снимките, с които вече разполагате. Заявете безплатна демонстрация на ръководство, за да може екипът ви да прегледа една продуктова задача, преди да реши как да я разшири.
