Dokumentacijske ekipe lahko potrjeno znanje o izdelku pretvorijo v vodnike za trenutke, ko morajo uporabniki ukrepati. Najkoristnejši prvi projekt poveže ponavljajoče se vprašanje z zanesljivim virom, ustreznim izdelkom in nalogo, ki jo je mogoče preveriti v praksi.
Dokumentacijske ekipe lahko potrjeno znanje o izdelku pretvorijo v vodnike za trenutke, ko morajo uporabniki ukrepati. Najkoristnejši prvi projekt poveže ponavljajoče se vprašanje z zanesljivim virom, ustreznim izdelkom in nalogo, ki jo je mogoče preveriti v praksi.
Za pregledljivo zahtevo ali nalogo uporabite naslednji kontekst: ponavljajoče se vprašanje, ustrezen izdelek, potrjen vir, terminološki zemljevid, odgovorni pregledovalec in postopek sprememb. Zabeležite, kaj je preverjeno in kaj ostaja neznano, nato z ustreznim virom izdelka določite naslednji potrjeni korak.
Preglejte podporna vprašanja glede ponavljajoče se zmede o enem delu, upravljalnem elementu ali koraku. Poiščite potrjeni odgovor in določite, za katere izdelke velja. Začnite s to omejeno nalogo, namesto da prenavljate vse priročnike ali izbirate vsebino samo zaradi visokega števila ogledov.
Zabeležite izdajo priročnika ali članka, strokovnega skrbnika in stanje pregleda. Vodnik je izpeljana vsebina, ki zahteva enako pozornost do sprememb kot njen vir. Pred objavo določite, kako posodobitev doseže prikaze, besedilo naloge in znanje pomočnika.
UI lahko pomaga urediti besedilo in predloge korakov, vendar preslikavo preverita pisec in odgovorni za izdelek. Nejasne sklice na diagrame, manjkajoče pogoje in nedosledno terminologijo ohranite na seznamu za pregled. Tekoč osnutek ne sme prikriti vrzeli v viru, ki še zahteva podatke tehnične ekipe.
Ponazoritveni uredniški primer: stranke okovje imenujejo nosilec, priročnik pa uporablja kataloški izraz. Vodnik poveže oba izraza s potrjeno oznako in položajem na diagramu. Osnovna referenca dela ostane nespremenjena, zato je razlaga razumljiva brez spremembe identitete delov izdelka.
Kjer je primerno, uporabite isto potrjeno nalogo na strani izdelka, v podpornem članku ali prek kode QR. Preverite, da vsaka vstopna točka določi model in izdajo. Ponovna uporaba naj zmanjša nasprotujoče si razlage, ne pa razmnožuje nepregledanega odgovora na več straneh.
Po nalogah izdelka beležite neskladja z virom, ponavljajoča se pojasnila in neodgovorjena vprašanja. Te signale preglejte s skrbnikom dokumentacije. Na podlagi dokazov dajte prednost jasnejšemu prikazu ali manjkajočemu odseku vira ter primerjajte enakovredne naloge, preden spremembe obsega podpore pripišete vodniku.
Pripravite zapis za interaktivne vodnike po izdelkih za dokumentacijske ekipe, ki poveže vir z dejansko nalogo. Spodnja kontekstna polja kopirajte v svoj produktni, podporni ali pregledni postopek. Dodajte sklic na ustrezni vir in odgovornega skrbnika, da naslednja ekipa vidi, kaj je še treba potrditi.
Zabeležite ponavljajoče se vprašanje, ustrezen izdelek in potrjen vir ter določite ustrezen vir.
S scenarijem odgovorne ponovne uporabe v različnih kanalih razpravljajte o obsegu, nato z odgovornim skrbnikom preglejte dejansko nalogo in odprta polja.
Ob nastalem zapisu ohranite terminološki zemljevid, odgovornega pregledovalca, postopek sprememb in nerešeno vprašanje.
Izberite eno ponavljajoče se vprašanje o izdelku s potrjenim virom in jasnim rezultatom naloge. Nejasno orientacijo ali sklic na del je pogosto lažje preveriti kot selitev celotnega priročnika izdelka.
Uporabite ponavljajoče se vprašanje, ustrezen izdelek, potrjen vir, terminološki zemljevid, odgovornega pregledovalca in postopek sprememb. Ločite preverjene identifikatorje, opažanja in nerešena vprašanja, da lahko naslednji skrbnik izbere ustrezen vir.
Manjkajočo podrobnost označite kot neznano in jasno pokažite odgovornega za njeno preverjanje. Z razpoložljivim ponavljajočim se vprašanjem in zapisi vira določite kontekst, preden predstavite odgovor za konkreten izdelek.
Prinesite en izdelek in potrjen vir za ponavljajoče se vprašanje. Osredotočena predstavitev lahko pokaže, kako označeni prikazi, pregledani koraki ali jasnejši podporni zapis pomagajo pri ponavljajočem se vprašanju in ustreznem izdelku. Pred razširitvijo izkušnje se dogovorite o pripravi in pregledu.
Pošljite odobren priročnik, diagrame ali fotografije, ki jih že imate. Zahtevajte brezplačno predstavitev vodnika, da lahko vaša ekipa pregleda eno opravilo z izdelkom, preden se odloči za razširitev.
