Produktdokumentation
Hjälp användarna att slutföra de uppgifter som din applikation stöder
Ge användarna praktiska guider som förklarar applikationens flöden och hjälper dem att slutföra sina uppgifter.
Gör produktens funktionalitet till praktiska instruktioner
- Förbered guidens omfattning
Granska dokumentationsavsnitten och deras avsedda målgrupp.
- Besvara frågor om innehållet
Förtydliga vilka arbetsflöden och vilken information en guide ska förklara.
- Följ den publika tjänsten
Granska byggförloppet och adressen till dokumentationswebbplatsen.
Förklara hur applikationen används
Dokumentationen kompletterar en produktpresentation med praktiska instruktioner. Börja med kom igång-guiden och led sedan användarna genom de arbetsflöden som applikationen faktiskt stöder.
Dokumentationskonfigurationen visar avsnittsdefinitionerna och frågorna. Ge sammanhang som hjälper till att förklara en uppgift på användarens språk.
Håll guiden kopplad till den fungerande applikationen
Stöd en första användbar åtgärd. En kom igång-guide ger nya användare en kort väg in i produkten. Den ska förklara var man börjar, vilken information som krävs och vilket resultat som bekräftar att uppgiften är slutförd.
Förklara ett återkommande arbetsflöde. En detaljerad guide följer applikationens verkliga etiketter och åtgärder. Förutsättningar, numrerade steg och ett förväntat resultat hjälper någon att upprepa en verksamhetsuppgift utan att behöva tolka en allmän beskrivning av skärmen.
Besvara en övergripande fråga. Vissa frågor gäller konton, kostnader eller publicering snarare än en enskild skärm. En FAQ ger ett kortfattat svar och länkar till den relevanta guiden, så att proceduren finns på ett ställe i stället för att upprepas på hela webbplatsen.
Håll guiderna kopplade till produkten
Granska dokumentationen efter en betydande ändring i applikationen. En guide ska använda de etiketter och det beteende som användarna faktiskt ser.
Dokumentationen körs på en egen publik tjänst. Länka till den från webbplatsen och kontrollera guiderna på de språk som ditt projekt publicerar.
Hjälp en användare att slutföra nästa uppgift
En praktisk guide förklarar var man börjar, vilken information som behövs och hur man kontrollerar resultatet. Dess värde ligger i att hjälpa läsaren att agera i applikationen.
Använd relaterade guider för att fortsätta resan när uppgiften berör flera områden. Granska dokumentationen när en skärm ändras så att instruktionerna förblir användbara efter en utveckling.
Från överenskommen funktionalitet till användbar hjälp
Förbered guidens omfattning. Granska dokumentationsavsnitten och de uppgifter som de ska förklara. Håll den avsedda användaren och applikationens beteende tydliga.
Ge det saknade sammanhanget. Besvara frågor om förutsättningar, regler och resultat. Texten ska använda det verkliga gränssnittet i stället för påhittade kontroller.
Granska efter publicering och ändring. Följ en guide i applikationen, kontrollera dess språk och relaterade länkar och gå sedan tillbaka till den när den underliggande uppgiften ändras.
Gör produkten lättare att använda efter första besöket
Ge instruktioner som leder till ett resultat, vid sidan av den publika presentationen av vad applikationen gör.
Frågor om produktdokumentation
En funktionssida hjälper en potentiell kund att förstå förmågan och dess värde. En guide hjälper en användare att utföra uppgiften, med de faktiska kontrollerna, förutsättningarna och resultatet. De kompletterar varandra.
Dokumentationsverktygen visar avsnittsdefinitioner och frågor. Granska de uppgifter som applikationen stöder, ge det saknade sammanhanget och följ skrivandets förlopp.
Projektet publicerar de lokaliserade guider som finns för dess omfattning. Granska varje publicerat språk så att den fullständiga proceduren och de korrekta gränssnittsetiketterna bevaras.
Efter en ändring som påverkar uppgiften, dess kontroller eller det förväntade resultatet. Jämför texten med den fungerande applikationen i stället för att anta att de ursprungliga instruktionerna fortfarande gäller.
En endpoint-referens hör till ett projekt med ett aktivt, fungerande API. Använd dess aktiva operationer och faktiska referens; planerade routes räcker inte för att dokumentera en användbar integration.