Termékdokumentáció
Segítse a felhasználókat az alkalmazása által támogatott feladatok elvégzésében
Adjon a felhasználóknak gyakorlati útmutatókat, amelyek elmagyarázzák az alkalmazás folyamatait, és segítenek elvégezni a feladataikat.
Alakítsa a termék funkcióit gyakorlati útmutatóvá
- Készítse elő az útmutató hatókörét
Tekintse át a dokumentációs szakaszokat és célközönségüket.
- Válaszoljon a tartalmi kérdésekre
Pontosítsa, milyen munkafolyamatokat és információkat magyarázzon el az útmutató.
- Kövesse a nyilvános szolgáltatást
Vizsgálja meg az építés előrehaladását és a dokumentációs webhely címét.
Magyarázza el, hogyan kell használni az alkalmazást
A dokumentáció gyakorlati útmutatással egészíti ki a termékbemutatót. Kezdje az első lépésekkel, majd vezesse végig a felhasználókat azokon a munkafolyamatokon, amelyeket az alkalmazás ténylegesen támogat.
A dokumentációs konfiguráció megjeleníti a szakaszdefiníciókat és a kérdéseket. Adjon meg olyan kontextust, amely segít a felhasználó nyelvén elmagyarázni egy feladatot.
Tartsa összhangban az útmutatót a működő alkalmazással
Támogassa az első hasznos műveletet. Egy első lépéseket bemutató útmutató rövid utat kínál az új felhasználóknak a termékhez. El kell magyaráznia, hol kell kezdeni, milyen információk szükségesek, és milyen eredmény igazolja a feladat elvégzését.
Magyarázzon el egy ismétlődő munkafolyamatot. Egy részletes útmutató az alkalmazás tényleges címkéit és műveleteit követi. Az előfeltételek, a számozott lépések és a várt eredmény segítenek megismételni egy üzleti feladatot anélkül, hogy a képernyő általános leírását kellene értelmezni.
Válaszoljon egy átfogó kérdésre. Egyes kérdések nem egy képernyőre, hanem fiókokra, költségekre vagy közzétételre vonatkoznak. A GYIK tömör választ ad, és a vonatkozó útmutatóra hivatkozik, így az eljárás egy helyen marad, ahelyett hogy a webhelyen többször ismétlődne.
Tartsa összhangban az útmutatókat a termékkel
Egy jelentős alkalmazásmódosítás után tekintse át a dokumentációt. Az útmutatónak a felhasználók által ténylegesen látott címkéket és működést kell használnia.
A dokumentáció saját nyilvános szolgáltatáson fut. Hivatkozzon rá a weboldalról, és ellenőrizze az útmutatókat azokon a nyelveken, amelyeken a projektje publikál.
Segítse a felhasználót a következő feladat elvégzésében
Egy gyakorlati útmutató elmagyarázza, hol kell kezdeni, milyen információkra van szükség, és hogyan ellenőrizhető az eredmény. Értéke abban rejlik, hogy segíti az olvasót az alkalmazásban végzett munkában.
Használja a kapcsolódó útmutatókat a folytatáshoz, ha a feladat több területet érint. Ha egy képernyő megváltozik, tekintse át a dokumentációt, hogy az útmutatás a továbbfejlesztés után is hasznos maradjon.
A megállapodott funkcióktól a hasznos súgóig
Készítse elő az útmutató hatókörét. Tekintse át a dokumentációs szakaszokat és az általuk magyarázandó feladatokat. Tartsa egyértelműen a célfelhasználót és az alkalmazás működését.
Adja meg a hiányzó kontextust. Válaszoljon az előfeltételekkel, szabályokkal és eredményekkel kapcsolatos kérdésekre. A szövegnek a valós felületre kell épülnie, nem kitalált vezérlőkre.
Áttekintés közzététel és módosítás után. Kövessen egy útmutatót az alkalmazásban, ellenőrizze a nyelveit és a kapcsolódó hivatkozásait, és vizsgálja felül, ha az alapul szolgáló feladat megváltozik.
Tegye könnyebben használhatóvá a terméket az első látogatás után
Adjon eredményhez vezető útmutatást az alkalmazás működésének nyilvános bemutatása mellett.
Kérdések a termékdokumentációról
Egy funkcióoldal segít az érdeklődőnek megérteni a képességet és annak értékét. Egy útmutató a tényleges vezérlőkkel, előfeltételekkel és eredménnyel segíti a felhasználót a feladat elvégzésében. Kiegészítik egymást.
A dokumentációs eszközök megjelenítik a szakaszdefiníciókat és a kérdéseket. Tekintse át az alkalmazás által támogatott feladatokat, adja meg a hiányzó kontextust, és kövesse az írás előrehaladását.
A projekt közzéteszi a hatóköréhez elérhető lokalizált útmutatókat. Tekintse át az egyes közzétett nyelveket, hogy megmaradjon a teljes eljárás és a helyes felületi címkék.
Olyan módosítás után, amely érinti a feladatot, annak vezérlőit vagy a várt eredményt. Ellenőrizze a szöveget a működő alkalmazáson, ahelyett hogy feltételezné, hogy az eredeti útmutatás továbbra is érvényes.
Egy végpont-referencia aktív, működő API-val rendelkező projekthez tartozik. Használja az élő műveleteit és a tényleges referenciát; a tervezett útvonalak nem elegendőek egy használható integráció dokumentálásához.