Dokumentacija izdelka
Pomagajte uporabnikom opraviti opravila, ki jih podpira vaša aplikacija
Uporabnikom ponudite praktične vodnike, ki pojasnijo poti v aplikaciji in jim pomagajo opraviti njihova opravila.
Funkcionalnost izdelka spremenite v praktična navodila
- Pripravite obseg vodnika
Preglejte razdelke dokumentacije in njihovo predvideno občinstvo.
- Odgovorite na vprašanja o vsebini
Pojasnite delovne postopke in informacije, ki naj jih vodnik razloži.
- Spremljajte javno storitev
Preglejte napredek izdelave in naslov spletnega mesta z dokumentacijo.
Pojasnite, kako uporabljati aplikacijo
Dokumentacija dopolnjuje predstavitev izdelka s praktičnimi navodili. Začnite s prvimi koraki, nato uporabnike vodite skozi delovne postopke, ki jih aplikacija dejansko podpira.
Konfiguracija dokumentacije prikazuje opredelitve razdelkov in vprašanja. Zagotovite kontekst, ki pomaga pojasniti opravilo v jeziku uporabnika.
Vodnik ohranite povezan z delujočo aplikacijo
Podprite prvo koristno dejanje. Vodnik za prve korake novim uporabnikom ponudi kratko pot v izdelek. Pojasniti mora, kje začeti, katere informacije so potrebne in kateri rezultat potrdi, da je opravilo dokončano.
Pojasnite ponavljajoč se delovni postopek. Podroben vodnik sledi dejanskim oznakam in dejanjem aplikacije. Predpogoji, oštevilčeni koraki in pričakovani izid pomagajo ponoviti poslovno opravilo brez razlage splošnega opisa zaslona.
Odgovorite na splošno vprašanje. Nekatera vprašanja se nanašajo na račune, stroške ali objavo in ne na en zaslon. Pogosta vprašanja dajo jedrnat odgovor in povežejo na ustrezni vodnik, tako da postopek ostane na enem mestu, namesto da bi se podvajal po vsem spletnem mestu.
Vodnike ohranite povezane z izdelkom
Po pomembni spremembi aplikacije preglejte dokumentacijo. Vodnik naj uporablja oznake in delovanje, ki jih uporabniki dejansko vidijo.
Dokumentacija deluje v lastni javni storitvi. Povežite jo s spletnega mesta in preverite vodnike v jezikih, ki jih vaš projekt objavlja.
Pomagajte uporabniku dokončati naslednje opravilo
Praktični vodnik pojasni, kje začeti, katere informacije so potrebne in kako preveriti rezultat. Njegova vrednost je v tem, da bralcu pomaga ukrepati v aplikaciji.
Ko opravilo zajema več področij, pot nadaljujte s povezanimi vodniki. Ko se zaslon spremeni, preglejte dokumentacijo, da navodila ostanejo uporabna tudi po spremembi.
Od dogovorjene funkcionalnosti do koristne pomoči
Pripravite obseg vodnika. Preglejte razdelke dokumentacije in opravila, ki naj jih pojasnijo. Predvideni uporabnik in delovanje aplikacije naj ostaneta jasna.
Dopolnite manjkajoči kontekst. Odgovorite na vprašanja o predpogojih, pravilih in izidih. Besedilo naj uporablja resnični vmesnik in ne izmišljenih kontrolnikov.
Pregled po objavi in spremembi. Sledite vodniku v aplikaciji, preverite njegove jezike in povezane povezave ter se k njemu vrnite, ko se spremeni opravilo, ki ga opisuje.
Olajšajte uporabo izdelka po prvem obisku
Ponudite navodila, ki vodijo do rezultata, ob javni predstavitvi tega, kar aplikacija počne.
Vprašanja o dokumentaciji izdelka
Stran s funkcijo pomaga potencialni stranki razumeti zmožnost in njeno vrednost. Vodnik pomaga uporabniku izvesti opravilo z resničnimi kontrolniki, predpogoji in izidom. Dopolnjujeta se.
Orodja za dokumentacijo prikazujejo opredelitve razdelkov in vprašanja. Preglejte opravila, ki jih aplikacija podpira, dopolnite manjkajoči kontekst in spremljajte napredek pisanja.
Projekt objavi lokalizirane vodnike, ki so na voljo za njegov obseg. Preglejte vsak objavljeni jezik, da ohrani celoten postopek in pravilne oznake vmesnika.
Po spremembi, ki vpliva na opravilo, njegove kontrolnike ali pričakovani rezultat. Besedilo primerjajte z delujočo aplikacijo, namesto da predpostavljate, da prvotna navodila še veljajo.
Referenca končnih točk sodi k projektu z aktivnim, delujočim API. Uporabite njegove žive operacije in dejansko referenco; načrtovane poti ne zadoščajo za dokumentiranje uporabne integracije.