A termékkiadási dokumentáció 15 legjobb gyakorlata

Ez a botlás megtanított arra, hogy a termékünket a vásárló prizmáján keresztül kell néznem. Ekkor a közmondásos villanykapcsoló "bekapcsolt". Ha olyan terméket szállítok, amely az ügyfél fájdalmas pontjait kezeli, majd professzionális termékdokumentációval támogatom, akkor nyertesünk lesz.

És azt is felfedeztem, hogy a professzionális, esztétikus és könnyen olvasható termékdokumentáció létrehozása nem könnyű feladat. De ha helyesen végezzük, a termékdokumentáció elégedett ügyfeleket hozhat lázba, és végső soron növelheti a bevételeket.

Melyek a legjobb gyakorlatok a professzionális termékdokumentáció létrehozásához?

Ezek a legjobb gyakorlatok esztétikus, informatív és könnyen használható termékdokumentációt hoznak létre. Ezen irányelvek betartása segít olyan termékdokumentációt készíteni, amely a jó ügyfelet nagyszerű ügyféllé teheti. A nagyszerű ügyfelek pedig végső soron segítenek a vállalatoknak a bevételek növelésében, a termékdokumentáció pedig a vásárlói élmény létfontosságú összetevője.

1. Értse meg a célközönségét, és adja meg nekik, amit akarnak.

Alapvető fontosságú, hogy tudd, mik a célközönséged elvárásai. Például a termékdokumentációt rendszergazdáknak vagy végfelhasználóknak szánja? A célközönség köre megkövetelheti, hogy a dokumentációt technikailag a rendszergazdáknak, vagy egyértelműen meghatározott kifejezésekkel és utasításokkal a végfelhasználóknak írja meg.

A professzionális termékdokumentáció készítésének legjobb gyakorlata az ügyfél elvárásainak megértése a rendszergazda vagy a végfelhasználó szintjén. Az azonosító célközönségi információk gyűjtésének néhány módszere a következő:

• Kérdőívek és felmérések

• A közönség által érzékelt visszajelzések

• Vállalati ötletelés

• Visszajelzés a népszerű vásárlói véleményekről

• Ügyfél kerekasztal-beszélgetések

2. Dokumentációs terv készítése legjobb gyakorlatként

A dokumentációs terv megírása segíthet a projekt megvalósítása során felmerülő esetleges szűk keresztmetszetek meglátásában. A termékdokumentáció létrehozása kihívást jelenthet, ezért a legjobb gyakorlat a dokumentációs terv elkészítése, amely segít előre látni a dokumentációs folyamat során felmerülő problémákat.

A dokumentációs terv készítésének előnyei közé tartoznak a következők:

• Elérhető elemek - A meglévő dokumentáció ellenőrzése az alkalmazható információk mentése érdekében**, amelyek az új termékdokumentációs tervvel újra felhasználhatók.

• Sablonok és stílusiratok betartása - Ha a termékdokumentáció egy új termékhez készül, győződjön meg arról, hogy az iparág hangvételén és stílusán belül marad, vagy ha a dokumentáció egy meglévő termékre vonatkozik, tartsa fenn a jelenlegi stílusirányzékokat és sablonokat, hogy biztosítsa a márka folyamatosságát.

• Dokumentációs folyamatok eszköztára - A dokumentációs eszközök meghatározhatják és ésszerűsíthetik a termékdokumentációs folyamatot, miközben biztosítják a csapatmunka folyamatosságát és a dokumentumfejlesztési folyamat jobb megértését.

3. A termékdokumentáció egyszerűsítése mint legjobb gyakorlat

2016-ban tanulmányt végeztek annak megállapítására, hogy hány felhasználó olvassa el a termékdokumentációt. Az eredmények szemet szúróak voltak, mivel kiderült, hogy csak a felhasználók 25%-a nem olvassa el a termékdokumentációt. A felmérés megállapította, hogy a termékdokumentáció el nem olvasásának hiánya a végfelhasználók részéről részben a következőkre vezethető vissza:

• A felhasználók türelmetlenek - Az interneten keresztül történő azonnali információ megjelenésével a felhasználók jellemzően kevésbé türelmesek a problémáikra adott válaszok felkutatásában. A termékdokumentáció online vagy offline olvasása fáradságos lehet az adott termékhez szükséges információk bőséges mennyisége miatt.

• Skip-ahead-szindróma - A felhasználók gyakran átugorják a szükséges termékdokumentációt, és egyenesen a termék használatának alapjaihoz térnek át. A felhasználók inkább a termékkel való interakció révén tanulják meg és értik meg a termékek működését, mintsem a részletes használati utasítások elolvasása révén. Az utasításoknak a lehető legvilágosabbnak és informatívabbnak kell lenniük.

• Zavaros elrendezés és szerkezet - A kézikönyvek gyakran olyan formátumban vannak megírva, hogy nehezen érthetőek és követhetőek. Sok felhasználó a termékdokumentációt zavarosnak vagy a kérdése szempontjából irrelevánsnak találja, így frusztrált és elkedvetlenedik a kézikönyv elolvasásától. Gyakran előfordul, hogy a vállalat nem végzett részletes közönségkutatást, és nem értette meg helyesen, hogy mire van szüksége a felhasználónak, és túlságosan összezavarodott ahhoz, hogy befejezze az olvasást.

4. Tartalmazzon képernyőképeket és grafikus információkat

Gondoljon a termékdokumentációra úgy, mint egy útitervre, amely egy történetet mesél el a termékről. Vezesse végig az ügyfelet egy olyan úton, amelyet képernyőképek vagy más grafikák segítségével könnyen megismerhet (https://theideanest.ca/5-types-graphics/?doing_wp_cron=1666462401.5462460517883300781250), és azt, hogy az egyes grafikák hogyan hatnak egymásra. Magyarázza el világosan, hogy mit néz a felhasználó, vagy mikor aktivál egy funkciót, hogyan reagál a termékre, és mire számíthat a továbbiakban. Győződjön meg arról, hogy minden egyes grafika célszerű, és hogy a termék munkafolyamata együttműködik egymással.

5. Használjon kereszthivatkozásokat a témák pontosabb megértéséhez.

A kereszthivatkozások felbecsülhetetlen értékűnek bizonyultak a termékdokumentáció olvasása során. Ha megérti, hogy egy funkció vagy funkciófolyamat mit csinál, az óriási segítséget nyújt a kapcsolódó témához való kereszthivatkozáshoz. Ezenkívül a kapcsolódó adatpontok kereszthivatkozásával az átfogó kép jobban láthatóvá válik a rendszer kölcsönhatása és a munkafolyamatok tekintetében.

6. Ne feledje a termékdokumentáció KISS-elvét.

Ne feledje a KISS (Keep It Simple, Stupid) elv alkalmazását a dokumentáció készítésekor. Fontos azonban, hogy alaposan dokumentáljuk a folyamatot, de ne menjünk a dokumentáció túlzásba viteléig. Ezen kívül a dokumentáció felhasználója bizonyos információkat kereshet bizonyos tételekről, így a KISS elv betartása sokkal könnyebb navigációt és a dokumentáció megértését teszi lehetővé.

Például egyszerű jelölések is elegendőek lehetnek egy funkció magyarázatához, esetleg egy hivatkozással (keresztlinkkel) a fő témára. Tartsa a tényeket tisztán és ne túlhangsúlyozva, így a felhasználó könnyen kereshet az igényeinek megfelelő információk között. Nem biztos, hogy érdekli őket a termék minden aspektusának elolvasása.

7. Alkalmazkodjon a különböző tanulási stílusokhoz

Minden embernek különböző tanulási stílusa van. Egyesek a mélyreható leírásokat kedvelik, míg mások a grafikákat és a vizuális ábrázolásokat. Néhány felhasználó azonban inkább a gyakorlati részvételen keresztül tanul, mint a koncentrált olvasáson keresztül.

A hatékony és informatív termékdokumentáció létrehozásakor ügyeljen arra, hogy minden tanulási stílust figyelembe vegyen. Például grafikák, például képernyőképek, grafikonok, strukturált szöveg vagy videólinkek beillesztése segít abban, hogy minden tanulási stílus megérthesse a termékdokumentációt.

8. Személyre szabja és strukturálja a bevezető tartalmat

Személyre szabja a termék dokumentációt a célközönség szerepe alapján. A dokumentáció különböző verzióit hozza létre a célközönség szerepei alapján a tartalom bevezetésekor. Például egy rendszergazda kérdései nem biztos, hogy relevánsak egy főfelhasználónak a dokumentációval kapcsolatos kérdéseihez képest.

A dokumentáció bevezetheti a személyre szabás egy rétegét azáltal, hogy a dokumentum kissé eltérő, inkább a célközönség szerepére irányuló változatait hozza létre. A bevezető tartalom módosítása a célközönség szerepe alapján személyre szabott elemet ad a dokumentációnak.

9. Határozza meg egyértelműen a célközönségnek szánt kifejezéseket

A célközönségtől függően jó gyakorlat, ha a dokumentációban használt minden egyes kifejezés jelentését megmagyarázza. Bonyolultabb kifejezéseket is használhat némi pontosítással, ha a célközönség belső célcsoport. Ha azonban külső felhasználók férnek hozzá a dokumentációhoz, nem lehet tudni, hogy a felhasználók milyen szakértelemmel rendelkeznek.

Az egyedi vagy összetett kifejezések egyértelmű meghatározása sokkal jobb és hatékonyabb kommunikációt hoz létre valamennyi belső érdekelt fél és külső felhasználó számára.

10. Módszer biztosítása a felhasználói visszajelzések összegyűjtésére

A dokumentációról adott visszajelzések erőteljes információt nyújtanak a dokumentum hatékonyságáról. Adjon meg egy linket vagy egy egyszerű "Tetszik/nem tetszik" gombot, hogy értékes információkat gyűjtsön a dokumentáció minőségéről. A felhasználói visszajelzések összegyűjtésével a dokumentáció finomítható és javítható.

11 Kerülje a lapos szerkezetű dokumentációt.

A termékdokumentáció készítésekor ügyeljen arra, hogy a dokumentáció ne "lapos szerkezetű" legyen. Egy lapos szöveggel teli dokumentum olvasása fárasztó, és unalmassá is válhat. Emellett az olvasó érdeklődése a dokumentáció iránt fokozódik, ha az információ releváns a tárgyalt témához, és az olvasó gyorsan el tudja fogyasztani.

Törje meg a folyamatos, lapos szöveget a kiválasztott információk kiemelésével vagy videók, képek, linkek és egyéb módszerek integrálásával, hogy jobb UX-et biztosítson. Emellett a dokumentum tartalmának "falatnyi" darabokban történő átadásával az olvasónak élvezetesebb élményben lesz része, és kevésbé fog vonakodni a dokumentáció elolvasásától.

12. Készítsen SEO-barát dokumentációt

Az online termékdokumentáció legjobb gyakorlata, hogy olyan stílusban írja meg, amely dokumentáció SEO-barát. Biztosítva, hogy a dokumentáció úgy legyen megírva, hogy maximalizálja a keresési találatokat az interneten a dokumentációra vonatkozóan. Az ügyfeleknek szükségük lehet a dokumentációjuk keresésére, és ha nincs meg a kifejezett link a tárhelyre, a keresőkifejezések megadásával a válaszok gyorsabbak és tömörebbek, ha SEO-barát.

13. Tartsa naprakészen a termékdokumentációt

A termékdokumentáció karbantartása kulcsfontosságú, elsősorban akkor, ha online érhető el. Gyakran előfordul, hogy a termékkel kapcsolatos követelmények változnak, és az online dokumentációnak tükröznie kell az új változásokat vagy frissítéseket. Ezért a felhasználói dokumentációnak naprakésznek kell lennie, és frissíteni kell a legutóbbi frissítésekhez, valamint biztosítani kell, hogy az ügyfél értesüljön és tudjon a termékdokumentációban bekövetkezett változásokról.

14. Értse meg, hogy a felhasználók nem feltétlenül olvassák el a termékdokumentációt.

Egy 2014-es tanulmány szerint a felhasználók nem olvasták el teljesen az összes termékdokumentációt. A dokumentáció el nem olvasásának elsődleges okai a következők voltak:

• A termékdokumentáció túlságosan összetett volt

• A dokumentáció nem foglalkozott közvetlenül a kérdéseikkel

• A felhasználók nem használták a termék számos funkcióját, mert nem olvasták el a dokumentációt

• A dokumentáció olvasása helyett sok felhasználó inkább a "gyakorlati" tanulást részesítette előnyben.

15. Dinamikus és statikus tartalom kezelése

A termékdokumentáció folyamatosan fejlődik frissítésekkel, új funkciókkal, javított tartalommal, frissített karbantartási figyelmeztetésekkel és egyéb elemekkel. Ez a frissítés élő, lélegző dokumentumnak tekinthető, amely folyamatosan fejlődik a termék követelményeinek megfelelően.

A statikus tartalom olyan adatokat biztosít a felhasználó számára, amelyek nem változnak a termék élettartama során. A statikus tartalom lényege, hogy a felhasználók, különösen az új felhasználók számára olyan információkat adjon referenciaként, amelyek a termék életciklusa során statikusak maradnak. A statikus tartalom elengedhetetlen a gazdag dokumentációhoz, de általában háttérbe szorul a dinamikus dokumentációval szemben.

A dokumentációkészlet karbantartása könnyebb, ha a tartalom dinamikus vagy statikus. A termék életciklusának dokumentációja könnyebben megvalósítható és validálható, ha a dokumentáció dinamikus vagy statikus kategóriába sorolható. A dokumentációban kisebb változtatások lehetnek az új funkciók frissítései (statikus) vagy a részletes termékfrissítések (dinamikus) miatt.

16. A termékdokumentáció rendelkezésre állásának legjobb gyakorlata

Bár a felhasználók nem feltétlenül olvasnak sok termékdokumentációt, ha szükségük van rá, azonnal kérik. A dokumentáció hagyományos szállítási módszere az volt, hogy a termékkel együtt egy nyomtatott kézikönyv is járt. A mai digitális, online világban azonban a dokumentációt gyakran az interneten keresztül szállítják.

Függetlenül attól, hogy a termékdokumentációt milyen módon szállítják, alapvető fontosságú, hogy könnyen elérhető hozzáférési pontok álljanak rendelkezésre. Ezért ma a dokumentáció biztosításának uralkodó módszerei a következők:

• Offline dokumentáció - Sok termékhez nyomtatott kézikönyveket vagy "Gyorsindító" rövid ismertetőket mellékelnek. Ezek a dokumentumok általában "egyszeri példányok", és nem könnyen terjeszthetők. Sok kézikönyv azonban opcionálisan kapszulázott PDF formátumban is rendelkezésre áll, ami elősegíti a hordozhatóságot vagy az igény szerinti nyomtatás lehetőségét.

• Online dokumentáció- Minden alkalommal, amikor a Google-on keres választ egy problémára, valószínűleg az online dokumentáció egy részletét is megragadja. A web megjelenése kiszorította a nyomtatott kézikönyveket vagy termékdokumentációs anyagokat a végfelhasználók számára. Az online dokumentáció néhány előnye a következő:

• Távmunka - A világjárvány megtanított minket arra, hogy az otthonról történő munkavégzés ugyanolyan produktív lehet, mint az irodában, különösen akkor, ha kérdéseinkre online dokumentációval kapunk választ.

• Együttműködés - Egy könnyen elérhető online dokumentációs portállal a csapattagok menet közben is megoszthatják az információkat, és olyan csapatmunkát hozhatnak létre, ami az irodában gyakran lehetetlen.

• Mobilbarát - A mobileszközök, például az iPadek és okostelefonok megjelenése lassan kiszorította a PC-ket a mindennapi interakciókban. Egy okostelefonnal könnyedén hozzáférhet az online dokumentációhoz, és bármilyen nyűgös termékprobléma könnyen felkutatható, akár a kedvenc kávézójában ebéd közben.