Dokumentatsioonimeeskonnad saavad muuta kinnitatud tooteteadmised juhenditeks hetkedel, mil kasutajad peavad tegutsema. Kõige kasulikum esimene projekt seob korduva küsimuse usaldusväärse allika, asjakohase toote ja praktikas ülevaadatava ülesandega.
Dokumentatsioonimeeskonnad saavad muuta kinnitatud tooteteadmised juhenditeks hetkedel, mil kasutajad peavad tegutsema. Kõige kasulikum esimene projekt seob korduva küsimuse usaldusväärse allika, asjakohase toote ja praktikas ülevaadatava ülesandega.
Kasutage järgmist konteksti, et päring või ülesanne oleks ülevaadatav: korduv küsimus, asjakohane toode, kinnitatud allikas, terminite vastavustabel, ülevaatuse eest vastutaja, muudatuste protsess. Salvestage kinnitatu ja teadmata teave, seejärel määrake asjakohase tooteallika põhjal järgmine kinnitatud samm.
Vaadake tugiküsimused läbi, et leida korduv segadus ühe osa, juhtseadise või sammu kohta. Leidke kinnitatud vastus ja määrake selle tooteulatus. Alustage sellest piiritletud ülesandest, selle asemel et kõik käsiraamatud ümber ehitada või valida sisu ainult suure lehevaatamiste arvu tõttu.
Salvestage käsiraamatu või artikli redaktsioon, valdkonna eest vastutaja ja ülevaatuse olek. Juhend on tuletatud sisu, mille muudatused vajavad sama tähelepanu kui allika omad. Enne avaldamist otsustage, kuidas uuendus jõuab visuaali, ülesande teksti ja assistendi teadmistesse.
Tehisintellekt saab aidata korraldada teksti ja võimalikke samme, kuid vastavust kontrollivad kirjutaja ja toote eest vastutaja. Hoidke mitmetähenduslikud skeemiviited, puuduvad tingimused ja vastuolulised terminid ülevaatusnimekirjas. Ärge laske ladusal mustandil varjata allikalünka, mis vajab endiselt inseneride panust.
Illustratiivne toimetamisjuhtum: kliendid nimetavad kinnitusdetaili kronsteiniks, samal ajal kui käsiraamat kasutab kataloogiterminit. Juhend seob mõlemad terminid kinnitatud sildi ja skeemiasukohaga. Kanooniline osaviide säilib, muutes selgituse arusaadavaks toote osade identiteeti muutmata.
Kasutage sama kinnitatud ülesannet vajaduse korral tootelehelt, tugiartiklist või QR-sisenemispunktist. Kontrollige, et iga sissepääs määrab mudeli ja redaktsiooni. Taaskasutus peaks vähendama vastuolulisi selgitusi, mitte kopeerima ülevaatamata vastust mitmele lehele.
Salvestage allikaga vastuolud, korduvad täpsustused ja vastamata küsimused tooteülesannete kaupa. Vaadake need signaalid läbi dokumentatsiooni eest vastutajaga. Eelistage tõendite põhjal selgemat visuaali või puuduvat allikaosa ning võrrelge samaväärseid ülesandeid enne tugimahu muutuste omistamist juhendile.
Valmistage dokumentatsioonimeeskondade interaktiivsete tootejuhendite jaoks kirje, mis seob allika tegeliku ülesandega. Kopeerige alltoodud kontekstiväljad oma toote-, toe- või ülevaatusprotsessi. Lisage asjakohane allikaviide ja vastutaja, et järgmine meeskond näeks, mis vajab veel kinnitamist.
Salvestage korduv küsimus, asjakohane toode, kinnitatud allikas ja määrake kohaldatav allikas.
Kasutage eri kanalites taaskasutuse vastutuse määramise stsenaariumi ulatuse arutamiseks, seejärel vaadake tegelik ülesanne ja täitmata väljad läbi koos selle vastutajaga.
Hoidke saadud kirjes terminite vastavustabel, ülevaatuse eest vastutaja, muudatuste protsess ja lahendamata küsimus.
Valige üks korduv tooteküsimus kinnitatud allika ja selge ülesandetulemusega. Segadust tekitavat suunda või osaviidet on sageli lihtsam üle vaadata kui kogu tootekäsiraamatu üleviimist.
Kasutage korduvat küsimust, asjakohast toodet, kinnitatud allikat, terminite vastavustabelit, ülevaatuse eest vastutajat ja muudatuste protsessi. Hoidke kontrollitud tunnused, tähelepanekud ja lahendamata küsimused eraldi, et järgmine vastutaja saaks valida asjakohase allika.
Märkige puuduv detail teadmata teabeks ja näidake selgelt selle kontrollimise eest vastutajat. Enne tootespetsiifilise vastuse esitamist looge kontekst olemasoleva korduva küsimuse ja allikakirjete abil.
Võtke kaasa üks toode ja korduva küsimuse kinnitatud allikas. Keskendatud demo saab näidata, kuidas sildistatud visuaalid, ülevaadatud sammud või selgem tugikirje aitavad korduva küsimuse ja asjakohase tootega. Enne kogemuse laiendamist leppige kokku ettevalmistus ja ülevaatus.
Saatke olemasolev heakskiidetud juhend, joonised või fotod. Taotlege tasuta juhendidemo, et teie meeskond saaks enne laiendamise otsustamist ühe tootega seotud ülesande üle vaadata.
