Dokumentacijos komandos gali paversti patvirtintas žinias apie gaminį vadovais tiems momentams, kai naudotojams reikia veikti. Naudingiausias pirmasis projektas susieja pasikartojantį klausimą su patikimu šaltiniu, taikomu gaminiu ir užduotimi, kurią galima peržiūrėti praktiškai.
Dokumentacijos komandos gali paversti patvirtintas žinias apie gaminį vadovais tiems momentams, kai naudotojams reikia veikti. Naudingiausias pirmasis projektas susieja pasikartojantį klausimą su patikimu šaltiniu, taikomu gaminiu ir užduotimi, kurią galima peržiūrėti praktiškai.
Naudokite šį kontekstą, kad užklausą ar užduotį būtų galima peržiūrėti: pasikartojantis klausimas, taikomas gaminys, patvirtintas šaltinis, terminų atitikmenų lentelė, atsakingas už peržiūrą, pakeitimų procesas. Užrašykite, kas patikrinta ir kas nežinoma, tada pagal taikomą gaminio šaltinį nustatykite kitą patvirtintą žingsnį.
Peržiūrėkite pagalbos klausimus ir raskite pasikartojantį neaiškumą dėl vienos dalies, valdiklio ar žingsnio. Suraskite patvirtintą atsakymą ir nustatykite jo gaminių aprėptį. Pradėkite nuo šios ribotos užduoties, užuot perdarę visus vadovus ar pasirinkę turinį vien dėl didelio peržiūrų skaičiaus.
Užrašykite vadovo ar straipsnio redakciją, atsakingą srities specialistą ir peržiūros būseną. Vadovas yra išvestinis turinys, kuriam reikia tiek pat dėmesio pakeitimams, kiek ir jo šaltiniui. Prieš skelbdami nuspręskite, kaip atnaujinimas pasieks vaizdus, užduoties tekstą ir asistento žinias.
DI gali padėti sutvarkyti tekstą ir galimus žingsnius, bet atitikimą tikrina rašytojas ir atsakingas už gaminį. Neaiškias schemų nuorodas, trūkstamas sąlygas ir nenuoseklius terminus palikite peržiūros sąraše. Neleiskite sklandžiam juodraščiui paslėpti šaltinio spragos, kuriai dar reikia inžinierių informacijos.
Iliustracinis redakcinis atvejis: klientai tvirtinimo detalę vadina laikikliu, o vadove naudojamas katalogo terminas. Vadovas abu terminus susieja su patvirtinta žyma ir vieta schemoje. Kanoninė dalies nuoroda išlieka nepakeista, todėl paaiškinimas suprantamas nekeičiant gaminio dalių tapatybės.
Kur tinka, naudokite tą pačią patvirtintą užduotį iš gaminio puslapio, pagalbos straipsnio ar QR prieigos taško. Patikrinkite, ar kiekviena prieiga nustato modelį ir redakciją. Pakartotinis naudojimas turi mažinti prieštaringus paaiškinimus, o ne kopijuoti neperžiūrėtą atsakymą į kelis puslapius.
Pagal gaminio užduotį registruokite neatitikimus šaltiniui, pasikartojančius tikslinimus ir neatsakytus klausimus. Peržiūrėkite šiuos signalus su atsakingu už dokumentaciją. Remdamiesi įrodymais pirmenybę teikite aiškesniam vaizdui ar trūkstamai šaltinio daliai ir palyginkite vienodas užduotis prieš priskirdami pagalbos apimties pokyčius vadovui.
Paruoškite interaktyvių gaminių vadovų dokumentacijos komandoms įrašą, susiejantį šaltinį su tikra užduotimi. Nukopijuokite žemiau esančius konteksto laukus į savo gaminio, pagalbos ar peržiūros procesą. Pridėkite taikomo šaltinio nuorodą ir atsakingą asmenį, kad kita komanda matytų, ką dar reikia patvirtinti.
Užrašykite pasikartojantį klausimą, taikomą gaminį, patvirtintą šaltinį ir nustatykite taikomą šaltinį.
Aptarkite apimtį naudodami atsakomybės už pakartotinį naudojimą skirtinguose kanaluose scenarijų, tada su atsakingu asmeniu peržiūrėkite tikrą užduotį ir neužpildytus laukus.
Gautame įraše išsaugokite terminų atitikmenų lentelę, atsakingą už peržiūrą, pakeitimų procesą ir neišspręstą klausimą.
Pasirinkite vieną pasikartojantį gaminio klausimą su patvirtintu šaltiniu ir aiškiu užduoties rezultatu. Neaiškią orientaciją ar dalies nuorodą dažnai lengviau peržiūrėti nei viso gaminio vadovo perkėlimą.
Naudokite pasikartojantį klausimą, taikomą gaminį, patvirtintą šaltinį, terminų atitikmenų lentelę, atsakingą už peržiūrą ir pakeitimų procesą. Patikrintus identifikatorius, pastebėjimus ir neišspręstus klausimus laikykite atskirai, kad kitas atsakingas asmuo galėtų pasirinkti taikomą šaltinį.
Trūkstamą detalę pažymėkite kaip nežinomą ir aiškiai nurodykite jos tikrinimo atsakingą asmenį. Prieš pateikdami konkretaus gaminio atsakymą, nustatykite kontekstą pagal turimą pasikartojantį klausimą ir šaltinių įrašus.
Atsineškite vieną gaminį ir patvirtintą pasikartojančio klausimo šaltinį. Tikslinė demonstracija gali parodyti, kaip pažymėti vaizdai, peržiūrėti žingsniai ar aiškesnis pagalbos įrašas padeda dėl pasikartojančio klausimo ir taikomo gaminio. Prieš plėsdami patirtį, sutarkite dėl paruošimo ir peržiūros.
Atsiųskite turimą patvirtintą vadovą, schemas ar nuotraukas. Užsisakykite nemokamą vadovo demonstraciją, kad jūsų komanda galėtų peržiūrėti vieną gaminio užduotį prieš nuspręsdama, kaip ją plėsti.
