Produktdokumentation
Hjælp brugerne med at fuldføre de opgaver, din applikation understøtter
Giv brugerne praktiske vejledninger, der forklarer applikationens forløb og hjælper dem med at fuldføre deres opgaver.
Omsæt produktets funktionalitet til praktiske instruktioner
- Forbered vejledningens omfang
Gennemgå dokumentationens sektioner og deres tilsigtede målgruppe.
- Besvar spørgsmål om indholdet
Afklar, hvilke arbejdsforløb og oplysninger en vejledning skal forklare.
- Følg den offentlige tjeneste
Se opbygningens fremdrift og adressen på dokumentationswebsitet.
Forklar, hvordan applikationen bruges
Dokumentation supplerer en produktpræsentation med praktiske instruktioner. Begynd med kom godt i gang, og led derefter brugerne gennem de arbejdsforløb, som applikationen faktisk understøtter.
Dokumentationskonfigurationen viser sektionsdefinitionerne og spørgsmålene. Giv kontekst, der hjælper med at forklare en opgave på brugerens sprog.
Hold vejledningen knyttet til den fungerende applikation
Understøt en første nyttig handling. En kom godt i gang-vejledning giver nye brugere en kort vej ind i produktet. Den skal forklare, hvor man begynder, hvilke oplysninger der kræves, og hvilket resultat der bekræfter, at opgaven er fuldført.
Forklar et tilbagevendende arbejdsforløb. En detaljeret vejledning følger applikationens rigtige etiketter og handlinger. Forudsætninger, nummererede trin og et forventet resultat hjælper nogen med at gentage en forretningsopgave uden at skulle fortolke en generel beskrivelse af skærmbilledet.
Besvar et tværgående spørgsmål. Nogle spørgsmål handler om konti, omkostninger eller publicering snarere end ét skærmbillede. En FAQ giver et kort svar og linker til den relevante vejledning, så proceduren findes ét sted i stedet for at blive gentaget på hele websitet.
Hold vejledningerne knyttet til produktet
Gennemgå dokumentationen efter en væsentlig ændring i applikationen. En vejledning skal bruge de etiketter og den adfærd, som brugerne faktisk ser.
Dokumentationen kører på sin egen offentlige tjeneste. Link til den fra websitet, og kontrollér vejledningerne på de sprog, dit projekt publicerer på.
Hjælp en bruger med at fuldføre den næste opgave
En praktisk vejledning forklarer, hvor man begynder, hvilke oplysninger der er nødvendige, og hvordan man kontrollerer resultatet. Dens værdi ligger i at hjælpe læseren til at handle i applikationen.
Brug relaterede vejledninger til at fortsætte forløbet, når opgaven går på tværs af flere områder. Gennemgå dokumentationen, når en skærm ændres, så instruktionerne forbliver nyttige efter en videreudvikling.
Fra aftalt funktionalitet til nyttig hjælp
Forbered vejledningens omfang. Gennemgå dokumentationens sektioner og de opgaver, de skal forklare. Hold den tilsigtede bruger og applikationens adfærd tydelige.
Angiv den manglende kontekst. Besvar spørgsmål om forudsætninger, regler og resultater. Teksten skal bruge den rigtige brugerflade i stedet for opdigtede kontroller.
Gennemgå efter publicering og ændring. Følg en vejledning i applikationen, kontrollér dens sprog og relaterede links, og vend tilbage til den, når den underliggende opgave ændres.
Gør produktet lettere at bruge efter det første besøg
Giv instruktioner, der fører til et resultat, ved siden af den offentlige præsentation af, hvad applikationen gør.
Spørgsmål om produktdokumentation
En funktionsside hjælper en potentiel kunde med at forstå muligheden og dens værdi. En vejledning hjælper en bruger med at udføre opgaven med de faktiske kontroller, forudsætninger og resultatet. De supplerer hinanden.
Dokumentationsværktøjerne viser sektionsdefinitioner og spørgsmål. Gennemgå de opgaver, applikationen understøtter, giv den manglende kontekst, og følg skrivearbejdets fremdrift.
Projektet publicerer de lokaliserede vejledninger, der er tilgængelige for dets omfang. Gennemgå hvert publiceret sprog, så den fulde procedure og de korrekte etiketter i brugerfladen bevares.
Efter en ændring, der påvirker opgaven, dens kontroller eller det forventede resultat. Sammenhold teksten med den fungerende applikation i stedet for at antage, at de oprindelige instruktioner stadig gælder.
En endpointreference hører til et projekt med et aktivt, fungerende API. Brug dets aktive operationer og den faktiske reference; planlagte ruter er ikke nok til at dokumentere en brugbar integration.