15 legjobb gyakorlat az új termékdokumentáció bevezetésekor

Egy új termék bevezetésekor az egyik legjobb gyakorlat a termékkiadás előkészítése. Különösen a termékbevezetést támogató új termékdokumentáció megírására szeretnénk összpontosítani. Enélkül a potenciális felhasználók nem fognak releváns információkkal rendelkezni, amelyeket az új megoldás megvásárlása után hivatkozási pontként használhatnak.

A szélesebb körű marketingstratégia részeként a termékmenedzsereknek és a termékcsapat tagjainak érdemes tovább olvasniuk, hogy megtudják, milyen 15 legjobb gyakorlatot érdemes követniük a következő bevezetés során. A végére megérti, hogyan teheti ezeket a fontos dokumentumokat a lehető legjobbá!

Milyen típusú termékdokumentációkkal kell tisztában lennem?

Mielőtt belemerülnénk a legjobb gyakorlatok listájába, tisztázzuk, milyen típusú termékdokumentációk léteznek, és mi a céljuk:

• Termékkövetelmény-dokumentáció - A termékkövetelmény-dokumentum vagy PRD a belső termékdokumentáció egy típusa, amelyet arra használnak, hogy segítse a vállalkozásokat a kiadási kritériumok teljesítésében. Ez elmagyarázza, hogy a végterméknek mit kell teljesítenie a felhasználó számára, anélkül, hogy konkrétan meghatározná, hogyan vagy hol. Ezután a fejlesztőcsapatok és a tesztelőcsapatok a PRD-t használják a termék kiadásra kész üzleti követelményekkel való összehangolására. A PRD-k a szoftvertermékeknél mindennaposak, de bármilyen termék ütemtervének betartására használhatók.

• Használati útmutatók és önkiszolgálás - A termékcsapatoknak a sikeres termékbevezetés puha előfeltételeként felhasználói útmutatókat kell készíteniük. Amint a név is mutatja, ez a dokumentáció a végfelhasználóknak segít abban, hogy maximalizálják termelékenységüket az új termék használata során. Itt minden fontosabb, a felhasználóval kapcsolatos funkciót teljes körűen el kell magyarázni, hogy az ügyfelek a lehető legnagyobb értéket kaphassák. Még jobb, ha ezeket az útmutatókat egy önkiszolgáló külső tudásbázisban osztja meg, hogy az ügyfelek segíthessenek maguknak!

• Elhelyezési, telepítési és konfigurációs útmutatók - Ha egy termék beállítási, telepítési és konfigurációs útmutatót igényel, akkor ez egy másik technikai termékdokumentációs eszköz, amelyet létre kell hoznia. A cél az, hogy ezeket a folyamatokat egyértelműen bemutassa a felhasználó és adott esetben a fejlesztő szemszögéből. Ez több eszközre és több operációs rendszerre is kiterjedhet, ha szoftverdokumentációról van szó; ezt érdemes szem előtt tartani.

• Marketing eszközök - Lehet, hogy nem gondolja, hogy ez termékdokumentáció, de az! A marketingeszközök stílusa és formátuma befolyásolja, hogy az ügyfelek hogyan érzékelik a terméket, még mielőtt elkezdenék használni. A jó benyomás keltése létfontosságú. Hogyan írja le a termék új funkcióit? Milyen célközönségnek szánja? Hogyan javítja majd valakinek a munkáját vagy a magánéletét? Ön és a vállalat egésze azt szeretné, hogy az ügyfelek ezt gondolják?

15 legjobb gyakorlat a dokumentációhoz új termékek bevezetésekor

A termékdokumentációról szóló alapozó után következik a legjobb gyakorlatok listája:

1: Kezdje el!

Csak most kezdi a termékdokumentációt? Nagyszerű! Most ne habozzon, kezdje el a munkát. Sokan TÖKÉLETES termékdokumentációt akarnak készíteni; és a tökéletességre való törekvés közben megbénítja őket a feladat. Írja papírra a szolgáltatásai alapkoncepcióját, majd összpontosítson a rendrakásra, készen arra, hogy lenyűgözze ügyfeleit. A kiadási jegyzetek kiválóan alkalmasak az alapok meghatározására, majd ebből a dokumentumból építkezhet.

2: Keep it Simple, Stupid...

Ez a KISS rövidítésű, valódi tervezési elv, amely a 60-as években az amerikai haditengerészetnél terjedt el (szóviccnek szánták). Ugyanez a szabály alkalmazható a termékdokumentációra is. Kérdezd meg magadtól: "Hogyan tudja a szükséges információt úgy közvetíteni, hogy azt minden demográfiai csoport megértse?".

Ha ezt alkalmazza termékvíziójára, ajánljuk a Flesch-Kincaid-féle olvashatósági tesztet. Az olyan tartalomosztályozó eszközök, mint a Grammarly, általában ezt a rendszert használják. Ez egy amerikai középiskolai osztályzatnak megfelelő pontszámot ad az írott tartalom elemzésekor. Törekedj a 8. osztályra vagy 13-14 éves korosztályra, mint iskolai életkorra, hogy maximalizáld a tartalom értelmezhetőségét - várj, mondhattuk volna... hogy mennyire könnyű megérteni az írásodat.

3: Értsd meg a célközönséget

Szóval, belevágtál, és egyszerűen fogalmaztál. Most már tudnod kell, hogy valójában kinek írsz... Példának okáért a szoftvercégek célközönsége egészen más lesz, mint egy autógyártóé.

Képzeljünk el egy oktatási szoftvercéget, amely olyan egyszerű eszközökre összpontosít, amelyek segítenek a fiatal diákoknak lépésről lépésre megtanulni a fogalmakat. Az első gondolat a fejedben talán az, hogy "szóval a célközönség a gyerekek, igaz?". Nem feltétlenül... A célközönség az óvodai vagy középiskolai szoftvercsomagok elsődleges döntéshozói - például az informatikai osztály és a beszerzésért felelős belső érintettek. A másodlagos célközönség a fiatal diákok lennének, akik esetleg látják az oktatási szoftvert a szabadban, és kiállnak az iskolájukban való használatáért.

4: Inkább az értékre koncentráljon, mint a történetre

Bár mindenki szereti a jó történetet, az ügyfelek tudni akarják, hogy milyen értéket nyújt a termék. Leegyszerűsít egy feladatot vagy munkafolyamatot? A termék offline is elérhető, szemben a versenytársakkal, akik csak online elérhetőek? Az Ön terméke gyorsabban elvégzi a dolgot, mint a versenytársak termékei?

Ezek a példák egy adott ajánlat egyedi értékesítési pontjait (USP) jelentik. Az USP-kre való összpontosítás és azok kiemelése csábítja a leendő ügyfeleket, és segít nekik megérteni, hogy mi az, amivel Ön rendelkezik, ami másoknak nincs, így növelve a piaci részesedést. Az USP-ket az iparági versenytársakkal végzett versenyelemzéssel határozhatja meg.

5: Használja ki a formázást az információk kategorizálására

A dokumentációnak nem szabad egy nagy szövegtömbnek lennie. Ezt nehéz átolvasni és navigálni a végfelhasználók számára. Ehelyett használjon címsorokat és más formázási lehetőségeket a szöveg tagolására.

A H1-fejlécek az első dolog, amit az emberek látnak, amikor rákattintanak egy oldalra. A H2 és H3 az oldalon tárgyalt témák alcímeként szolgál. Használhat felsoroláspontokat vagy számozott listákat a tartalom csoportosítására a könnyebb olvashatóság érdekében, sőt, a SEO és a SERPS láthatóság javítása érdekében Rich Snippetekre is jogosulttá válhat. Ha rendelkezik Markdown-ismeretekkel, egy olyan online Markdown-szerkesztő, mint a Docsie, számos formázási lehetőséget kínál, hogy termékdokumentumait kiemelkedővé tegye!

6: Tartsa dokumentációját egy központi helyen

Nincs rosszabb, mint kiadni a technikai dokumentációt, majd rájönni, hogy milyen bonyolult lesz azt hosszú távon nyomon követni és kezelni. Mi van, ha a dokumentációnak frissítésre van szüksége? Hol van az eredeti dokumentum, és hogyan adhatjuk ki az oldal új verzióit? Mi a helyzet a tartalom más nyelvekre történő lefordításával?

Ehhez a legjobb gyakorlathoz meg kell említenünk a Docsie! Az online tudásbázis-szoftver lehetővé teszi, hogy a dokumentumokat egyetlen központi felhőalapú helyen tárolja. Innen az alkalmazottak és a vállalkozók együttműködhetnek a tartalmakon, hogy felgyorsítsák a bevezetésre kész befejezést. A Docsie verziókezelést kínál, ha frissíteni kell a tudást, és nyelvi kezelést a globális tartalomlokalizációhoz. Ha automatizálni szeretné a globális tartalomkészítést, van egy ügyes szellemes AI-nyelvi fordítórobotunk is, amely a háttérben pontosan fordít Ön helyett!

7: Egy kép ezer szót mond

Bár egy hosszadalmas magyarázat megírása arról, hogyan kell csinálni a dolgot, működik, ez nem hatékony módja a végfelhasználók tanításának. Ehelyett mutassa meg nekik képekkel, vagy akár mozgóképekkel!

Próbáljon meg minden egyes termékdokumentumhoz kísérő videós oktatóanyagot készíteni. Így azok, akik inkább olvasni szeretnek, átfuthatják a szöveget, míg a vizuális tanulók a videót választhatják. Hasonlóképpen, a GIF-ek és képek segíthetnek a felhasználóknak abban, hogy lássák, mire utal, különösen egy szoftver felhasználói felületén (UI) belül. A különböző tanulási stílusok figyelembevételével a felhasználók szélesebb körének segíthet, ami nagyobb potenciált jelent a termékében.

8: Tanulás vs. Célok vs. Megértés vs. Információ

Mi a dokumentum célja? A felhasználói szándék kritikus fontosságú az online termékdokumentáció esetében, és segít Önnek a tartalmat a felhasználói út szakaszaihoz igazítani.

• Tanulás - Ha valaki még sosem látott valamit, a tanulási tartalom segít neki megérteni az alapelveket.

• Célok - Az ilyen típusú tartalomnak segítenie kell a felhasználókat egy cél elérésében, például "Hogyan exportálhatok PDF-fájlt a Docsie-ból". A végére a felhasználó elérte a célt: egy PDF exportálását.

• Megértés - Más néven kutatásnak is nevezik, ez az ügyfelek számára készült, akik már rendelkeznek működő ismeretekkel egy témában, de mélyebben szeretnék megérteni.

• Információ - Az ügyfélnek kérdése van, és konkrét választ szeretne kapni. Ez lehet olyan egyszerű, mint a valós idejű időjárás egy adott helyen, vagy egy videó arról, hogy "hogyan kell faházat építeni".

9: Tegye kereshetővé

Mielőtt nyilvánosságra hozná ezt a dokumentációt, a felhasználók tudnak-e keresni a szövegben kulcsszavakra?

Ha nem, javasoljuk, hogy keressen olyan dokumentációs platformot, amely támogatja ezt. A felhasználók számára az első számú visszatartó erő az, ha nem tudnak gyorsan információt találni. Ez frusztrációhoz, az ügyfélszolgálati csapat további munkaterheléséhez vezet, ha nem találják az információt, és negatív általános ügyfélélményhez (CX). Ó, a Docsie támogatja a globális keresést, ha kíváncsi lenne rá!

10: Felkészülés a használható visszajelzések gyűjtésére

A dokumentáció írói tisztában vannak azzal a ténnyel, hogy a tartalom kezdeti változata a későbbiekben biztosan változni fog. Amíg a nyilvánosság nem látja a dokumentációt, az írói csak egymásról tudnak ötleteket és visszajelzéseket adni.

Amint a dokumentáció közzététele megtörtént, úgy véljük, hogy elengedhetetlen a visszajelzések összegyűjtése. Így az írók a valódi ügyfelek és végfelhasználók meghallgatásával a tartalommal kapcsolatos negatívumokat pozitívumokká alakíthatják. Nem kell máshol keresgélnie, a Docsie-ban kihasználhatja a visszajelzésgyűjtés előnyeit!

11: Egy oldalra való hivatkozás, amikor megemlít egy témát

Ez a legjobb gyakorlat a SEO-ba és a weboldalak navigációs struktúrájába hajlik.

Amikor megemlít egy kulcsszót, hivatkozik rá? Amikor más témákra hivatkozik, a felhasználók még nem biztos, hogy értik a másik témát az aktuális oldal kontextusában. Minden olyan említett témára érdemes hivatkoznia, amely dokumentációval rendelkezik, mivel ez lehetővé teszi az olvasók számára, hogy gyorsan hivatkozhassanak az altémákra, miközben megismerkednek a fő témával.

12: Világosság, nem kétértelműség

A termékdokumentáció megírásakor az egyértelműség legyőzi a kétértelműséget. A kétértelműség elkerülése érdekében használhat egyszerű angol nyelvet, ami alapvetően a szakzsargon és a szaknyelv elkerülését jelenti, hacsak nem feltétlenül szükséges. Ha mégis szakzsargont használ, akkor a laikus olvasók számára közvetlenül utána írjon egy egyszerűsített definíciót.

"Ha problémái vannak az ebben a dokumentációban szereplő információk megértésével, kérjük, kérjen további részleteket a megértési nehézség leküzdésére vonatkozóan ügyfélszolgálati munkatársunktól."

"Ha a megjelenített tartalom nehezen érthető, kérje ügyfélszolgálatunk segítségét."

Ön melyiket részesíti előnyben?

13: Sablonok létrehozása a dokumentumok gyorsabb elkészítéséhez

Egy új termék bevezetésekor a dokumentációkészítési folyamat felgyorsítása kiemelt fontosságú. Ezt sablonok segítségével teheti meg.

A sablonok újrafelhasználható struktúrát határoznak meg az oldalak számára, segítve az íróknak a tartalom gyorsabb és következetesebb létrehozásában. Többféle sablont is létrehozhat a különböző tartalmi stílusokhoz. A Docsie számos előre elkészített sablont kínál az Ön számára, az egyéni sablonok támogatása mellett.

14: Hangnem és stílusirányzat létrehozása az írók számára

Mennyi szabad kezet kapnak az írói?

Fontos, hogy az írók korlátozzák a szabadságukat, mivel ez következetlenséghez vezethet a termékdokumentáció végső tervezeteiben. Ezt a hangnemre vonatkozó irányelvekkel (Tone of Voice, ToV) és tartalomírói stílusirányelvekkel teheti meg.

• Hangszínvonal - Nem az számít, hogy mit mondtál... hanem az, ahogyan mondtad. Azt szeretné, ha az írók hivatalosak és korrektek lennének, vagy inkább lazábbak? A humor megengedett, vagy a témák komolyabbak? A tartalom inkább beszélgetős és szenvedélyes, vagy csak rideg-kemény tényeket szeretne?

• Stílusirányelvek - Ez a dokumentum elmagyarázhatja a vállalat küldetésnyilatkozatát, és azt, hogy az írók hogyan követhetnek egy meghatározott stílust az oldalak írása és formázása során. Ide tartozhatnak a megcélzott felhasználói személyiségek, a SEO-elvek, például a meta leírások, és az idézési vagy hivatkozási követelmények (Chicago, AP Style stb.).

15: Dokumentációjának közzététele egy hatékony tudásbázis platform segítségével

Ha az írott tartalma üzemanyag, milyen járművet használ az üzenet hazavezetésére?

A minőségi termékdokumentáció terjesztéséhez elengedhetetlen egy hatékony tudásbázis-platform. Ha a dokumentumok elérhetetlenné válnak, vagy az oldalak lassan töltődnek be, a dokumentumok létrehozására fordított összes erőfeszítés kárba vész.

Lehetőséget kell biztosítani a meglévő dokumentumok importálására, a belső csapatokkal való tartalmi együttműködésre, új dokumentumok létrehozására és szerkesztésére, dinamikus, gazdag tartalom beágyazására és a tudásalapú webhelyen való közzétételre. A hosszú távú dokumentáció-frissítésekhez a verziókezelés is kritikus fontosságú, a nyelvkezelés és az automatikus fordítás mellett a globális tartalom lokalizációjához.

Kitalálta! Mindezek a funkciók elérhetők a Docsie-ban. Próbálja ki ezeket a funkciókat, próbálja ki a Free Forever csomagunkat, hogy elkezdhesse!