Produkto dokumentacija
Padėkite vartotojams atlikti užduotis, kurias palaiko jūsų programa.
Pateikite vartotojams praktinius vadovus, kuriuose paaiškinami programėlės veikimo etapai ir padedama jiems atlikti užduotis.
Paverskite produkto funkcionalumą į praktinius nurodymus
- Paruoškite vadovaujančio taikiklio prietaisą
Peržiūrėkite dokumentacijos skyrius ir jų numatytąją auditoriją.
- Atsakykite į turinio klausimus
Paaiškinkite darbo eigas ir informaciją, kurią turėtų pateikti vadovas.
- Sekite viešąją tarnybą
Patikrinkite statybos pažangą ir dokumentacijos svetainės adresą.
Paaiškinkite, kaip naudoti programėlę.
Dokumentacija papildo produkto pristatymą praktinėmis instrukcijomis. Pradėkite nuo pradžios, tada padėkite vartotojams įsisavinti darbo eiga, kurią iš tikrųjų palaiko programa.
Dokumentacijos konfigūracija atskleidžia skyrių apibrėžimus ir klausimus. Pateikite kontekstą, kuris padėtų paaiškinti užduotį vartotojo kalba.
Laikykite vadovą prijungtą prie veikiančios programos
Palaikykite pirmąjį naudingą veiksmą. Pradedančiųjų vadovas suteikia naujiesiems vartotojams trumpą įvadą į produktą. Jame turėtų būti paaiškinta, nuo ko pradėti, kokia informacija reikalinga ir koks rezultatas patvirtina, kad užduotis atlikta.
Paaiškinkite pasikartojantį darbo eigos procesą.. Toliau pateikiamas išsamus vadovas, kuriame nagrinėjami tikri parinkčių etiketės ir veiksmai. Reikalavimai, sunumeruoti žingsniai ir numatomas rezultatas padeda atlikti verslo užduotį, nereikalaujant interpretuoti bendro ekrano aprašymo.
Atsakykite į bendrą klausimą. Kai kurie klausimai susiję su paskyromis, sąnaudomis arba publikavimu, o ne su vienu ekranu. Daiktų skiltyje pateikiami trumpi atsakymai ir nuorodos į atitinkamą vadovą, todėl procedūra yra vienoje vietoje, o ne dubliuojama visame svetainės puslapyje.
Palikite vadovus prijungtus prie produkto
Peržiūrėkite dokumentaciją po esmingų programos pakeitimų. Vadovėlyje turėtų būti naudojami žymės ir vartotojams matomas elgesys.
Dokumentacija veikia atskirame viešajame serveryje. Prijunkite ją prie svetainės ir peržiūrėkite vadovus tomis kalbomis, kuriomis jūsų projektas yra skelbiamas.
Padėkite naudotojui atlikti kitą užduotį
Praktiniame vadove paaiškinama, nuo ko pradėti, kokios informacijos reikia ir kaip patikrinti rezultatą. Jo vertė – padėti skaitytojui veikti programoje.
Kai užduotis apima kelias sritis, kelią tęskite susijusiais vadovais. Kai ekranas pasikeičia, peržiūrėkite dokumentaciją, kad instrukcijos liktų naudingos ir po pokyčio.
Nuo sutartų funkcijų iki naudingos pagalbos
Paruoškite apžvalgos teleskopą. Peržiūrėkite dokumentacijos skirsnius ir užduotis, kurias jie turėtų paaiškinti. Užtikrinkite, kad numatytas naudotojas ir programos veikimas būtų aiškūs.
Pateikite trūkstamą kontekstą. Atsakykite į klausimus apie išankstinius reikalavimus, taisykles ir rezultatus. Tekstas turėtų naudoti tikrąją sąsają, o ne išgalvotą.
Peržiūrėkite po paskelbimo ir atlikite pakeitimus.. Vadovaukitės instrukcijomis programoje, patikrinkite kalbas ir susijusias nuorodas, o paskui peržiūrėkite jas, kai pagrindinė užduotis pasikeis.
Padarykite, kad produktu būtų lengviau naudotis po pirmojo vizito
Pateikite instrukcijas, kurios lemia konkretų rezultatą, kartu su viešuoju programos veikimo aprašymu.
Klausimai apie produkto dokumentaciją
Funkcijų puslapis padeda potencialiam klientui suprasti galimybes ir jų naudą. Vadovas padeda vartotojui atlikti užduotį, pateikiant faktinius valdiklius, būtinas sąlygas ir rezultatą. Jie papildo vienas kitą.
Dokumentacijos įrankiai pateikia skyrių apibrėžimus ir klausimus. Peržiūrėkite, kokias užduotis palaiko programa, pateikite trūkstamą kontekstą ir sekite rašymo pažangą.
Projektas skelbia lokalizuotus vadovus, prieinamus jo srities vartotojams. Peržiūrėkite kiekvieną paskelbtą kalbą, kad būtų išlaikta visa procedūra ir teisingi sąsajos etiketės.
Pakeitus užduotį, jos valdiklius arba numatomą rezultatą, palyginkite tekstą su veikiančia programa, o ne manykite, kad pradinės instrukcijos vis dar yra galiojančios.
Galinis taško nuorodos taškas priklauso projektui, kuriame veikia aktyvus API. Naudokite jo tiesiogines operacijas ir tikrąją nuorodą; planuojamų maršrutų nepakanka, kad būtų galima dokumentuoti naudingą integraciją.