Produktdokumentasjon
Hjelp brukerne med å fullføre oppgavene applikasjonen din støtter
Gi brukerne praktiske veiledninger som forklarer applikasjonens forløp og hjelper dem med å fullføre oppgavene sine.
Gjør produktfunksjonalitet om til praktiske instruksjoner
- Forbered omfanget av veiledningen
Gå gjennom dokumentasjonsseksjonene og målgruppen deres.
- Svar på spørsmål om innholdet
Avklar hvilke arbeidsflyter og hvilken informasjon en veiledning skal forklare.
- Følg den offentlige tjenesten
Se fremdriften i byggingen og adressen til dokumentasjonsnettstedet.
Forklar hvordan applikasjonen brukes
Dokumentasjon utfyller en produktpresentasjon med praktiske instruksjoner. Begynn med kom i gang, og led deretter brukerne gjennom arbeidsflytene applikasjonen faktisk støtter.
Dokumentasjonskonfigurasjonen viser seksjonsdefinisjonene og spørsmålene. Gi kontekst som hjelper med å forklare en oppgave på brukerens språk.
Hold veiledningen knyttet til den fungerende applikasjonen
Støtt en første nyttig handling. En kom i gang-veiledning gir nye brukere en kort vei inn i produktet. Den skal forklare hvor man begynner, hvilken informasjon som kreves, og hvilket resultat som bekrefter at oppgaven er fullført.
Forklar en tilbakevendende arbeidsflyt. En detaljert veiledning følger applikasjonens virkelige etiketter og handlinger. Forutsetninger, nummererte trinn og et forventet resultat hjelper noen med å gjenta en forretningsoppgave uten å måtte tolke en generell beskrivelse av skjermen.
Svar på et tverrgående spørsmål. Noen spørsmål gjelder kontoer, kostnader eller publisering snarere enn én skjerm. En FAQ gir et kort svar og lenker til den aktuelle veiledningen, slik at prosedyren finnes ett sted i stedet for å gjentas over hele nettstedet.
Hold veiledningene knyttet til produktet
Gå gjennom dokumentasjonen etter en betydelig endring i applikasjonen. En veiledning skal bruke etikettene og virkemåten brukerne faktisk ser.
Dokumentasjonen kjører på sin egen offentlige tjeneste. Lenk til den fra nettstedet, og kontroller veiledningene på språkene prosjektet ditt publiserer på.
Hjelp en bruker med å fullføre neste oppgave
En praktisk veiledning forklarer hvor man begynner, hvilken informasjon som trengs, og hvordan man kontrollerer resultatet. Verdien ligger i at den hjelper leseren til å handle i applikasjonen.
Bruk relaterte veiledninger til å fortsette forløpet når oppgaven går på tvers av flere områder. Gå gjennom dokumentasjonen når en skjerm endres, slik at instruksjonene forblir nyttige etter en videreutvikling.
Fra avtalt funksjonalitet til nyttig hjelp
Forbered omfanget av veiledningen. Gå gjennom dokumentasjonsseksjonene og oppgavene de skal forklare. Hold den tiltenkte brukeren og applikasjonens virkemåte tydelige.
Gi den manglende konteksten. Svar på spørsmål om forutsetninger, regler og resultater. Teksten skal bruke det virkelige grensesnittet i stedet for oppdiktede kontroller.
Gå gjennom etter publisering og endring. Følg en veiledning i applikasjonen, kontroller språkene og de relaterte lenkene, og gå tilbake til den når den underliggende oppgaven endres.
Gjør produktet enklere å bruke etter første besøk
Gi instruksjoner som fører til et resultat, ved siden av den offentlige presentasjonen av hva applikasjonen gjør.
Spørsmål om produktdokumentasjon
En funksjonsside hjelper en potensiell kunde med å forstå muligheten og verdien den gir. En veiledning hjelper en bruker med å utføre oppgaven, med de faktiske kontrollene, forutsetningene og resultatet. De utfyller hverandre.
Dokumentasjonsverktøyene viser seksjonsdefinisjoner og spørsmål. Gå gjennom oppgavene applikasjonen støtter, gi den manglende konteksten, og følg fremdriften i skrivingen.
Prosjektet publiserer de lokaliserte veiledningene som er tilgjengelige for omfanget. Gå gjennom hvert publiserte språk, slik at hele prosedyren og de riktige etikettene i grensesnittet bevares.
Etter en endring som påvirker oppgaven, kontrollene eller det forventede resultatet. Sammenhold teksten med den fungerende applikasjonen i stedet for å anta at de opprinnelige instruksjonene fortsatt gjelder.
En endepunktreferanse hører til et prosjekt med et aktivt, fungerende API. Bruk de aktive operasjonene og den faktiske referansen; planlagte ruter er ikke nok til å dokumentere en brukbar integrasjon.