Számos technológiai SaaS-vállalat küzd a termékdokumentáció (felhasználói kézikönyvek, felhasználói útmutatók és/vagy útmutatók) kifejlesztésének és a fogyasztók számára történő terjesztésének folyamatával.
Ez gyakran azért történik, mert nem ismerik a kézikönyvek megfelelő kezelésével és elkészítésével kapcsolatos ismereteket vagy folyamatokat, vagy akár azt sem, hogy ki a felelős ezekért.
Amíg a világon szükség van eszközökre és szoftverekre, addig szükségünk lesz hatékony kommunikációra, hogy hatékonyan közvetítsük másoknak ezen áruk használatát, fejlesztését, működését és felépítését. Ha azon tűnődik, hogy miért van ez így, a válasz egyszerű. Ez annak köszönhető, hogy a műszaki kommunikációs készségek elengedhetetlenek az információgyűjtéshez és ahhoz, hogy a közönség hatékonyabban megértse a terméket vagy technológiát.
Míg a valós világban a kommunikáció a beszéd, a testbeszéd és az érzelemkifejezések révén történik, addig a virtuális világban a műszaki kommunikáció a műszaki termékdokumentáción keresztül zajlik!
A műszaki termékdokumentáció egyetlen célja, hogy megkönnyítse a felhasználó számára egy termék és technológia működési dinamikájának és felépítésének megértését. Ez inkább olyan, mint egy "hogyan használd" kézikönyv az új dolgozók, felhasználók/ügyfelek és bárki más számára, akinek tisztában kell lennie a munkamódszerekkel, egy termék dióhéj és csavarjainak alapos leírása!
A termékmenedzserek kötelessége, hogy magukra vállalják egy olyan csapat kialakításának felelősségét, amely a csiszolt termékdokumentáció létrehozását, kezelését, közzétételét és karbantartását végzi.
Biztos vagyok benne, hogy minden termékmenedzser mondta vagy hallotta már a következőket az osztályán: "A termékdokumentáció a terméktulajdonos kötelezettségeinek része"; "Minden fejlesztőcsapatnak dokumentálnia kell a saját alkalmazásait"; "a funkciót már telepítették, frissítették-e a kézikönyvet?", vagy ami még rosszabb: "hiba van a műszaki dokumentációban".
Nyilvánvaló, hogy a műszaki termékdokumentáció amilyen egyszerűnek tűnik, olyan rejtélyes is lehet! Miközben az egyének megpróbálják megoldani vagy vitatkozni az előző bekezdésben szereplő sorokat, a kézikönyvek és útmutatók romlanak, ami károsan hat a "termék/cég" imázsára.
Hogy segítsünk mindazoknak, akik hasonló problémákkal küzdenek, íme néhány eljárás, amelyet a termékdokumentáció optimalizálása érdekében végre kell hajtani.
Mi a termékdokumentáció célja?
Amikor egy technológiai termék vagy szolgáltatás termékdokumentációjáról beszélünk, akkor az azt leíró információkról és a hozzá tartozó adatokról beszélünk.
A műszaki dokumentáció vagy termékdokumentáció lényege, hogy segítse a közönséget és az ügyfeleket a termékének használatában, elolvasásában, megértésében és felhasználásában. A legtöbb termékdokumentáció természetesen különböző területeken készül, többek között a mérnöki, az orvosi, az informatikai és a marketing területén.
A nagyszerű műszaki termékdokumentáció segít a közönségének eligazodni a termékében, és lehetővé teszi számukra, hogy komplikációk nélkül használhassák azt.
Egy másik szempont, hogy a műszaki dokumentáció kritikus fontosságú az ügyfelek segítése szempontjából, és jelentősen hozzájárul vállalata márkaépítéséhez és bizalmához. Amikor a legnagyobb szükségük van rá, a felhasználók a műszaki dokumentációt keresik. A közönség az Ön termékét használja a folyamatok megismerésére és a problémák kezelésére.
Ez azt jelenti, hogy nagyon fontos, hogy alapos és átfogó termékdokumentációval rendelkezzen, amely dinamikus, keresési lehetőségekkel rendelkezik.
Melyek a különböző termékdokumentációk
Ebben a részben láthatja, hogy milyen termékdokumentációra van szüksége ügyfelei vagy ügyfelei számára.
Számos különböző termékdokumentáció-típus létezik, amelyek megfelelnek a különböző típusú felhasználási esetek és felhasználói igények igényeinek:
Termék felhasználói dokumentáció: Ez felhasználói kézikönyvekből, használati útmutatókból, útmutatókból, útmutatókból, GYIK-ekből, kiadási jegyzetekből és képzési kézikönyvekből, valamint üzemeltetési eljárásokból áll.
Vállalati dokumentáció: Felmérések szerint a megkérdezett 1000 vállalkozásból 10-ből több mint 8 vállalat hivatalos szabályzatokat és eljárási kézikönyveket használ.
Számos más vállalati dokumentáció is létezik, amelyek a fenti kutatásban említett vállalati irányelvekre és eljárásokra, oktatási kézikönyvekre, műszaki gyakorlatokra, viselkedési és etikai dokumentációra utaló dokumentációból állnak. Valamint jogi dokumentáció, amely jelszóval védett lehet. A vállalati struktúrák, legjobb gyakorlatok és eljárások, valamint a karbantartási kézikönyvek.
Elfejlesztői dokumentáció: ez a fajta dokumentáció a szoftvertermékek fejlesztésére vonatkozó utasításokat, funkcionális specifikációkat, műszaki specifikációkat, dokumentációt és a fejlesztői munkafolyamatokat segítő eszközöket tartalmaz.
Most, hogy jobban megértettük a műszaki és termékdokumentáció különböző típusait, beszéljük meg, hogy mivel kezdődik a termékdokumentáció fejlesztési folyamatának szilárd irányításának első lépései.
A termékdokumentáció-fejlesztés vezetőjének megtalálása
Nagyon tipikus kérdés annak meghatározása, hogy ki legyen a termékdokumentáció felelőse, nem úgy, mint aki csak frissíti, hanem úgy, mint aki felelős a termék minőségéért és sikeréért.
Míg egyes vállalkozások úgy vélik, hogy minden egyes terméktulajdonos és/vagy termékmenedzser felelős a termékdokumentációért, addig más részlegek, például a fejlesztési és támogatási docs is megbízhatók azzal a felelősséggel, hogy a felhasználói kézikönyveket, felhasználói útmutatókat és a termékdokumentáció minden aspektusát naprakészen és hatékonyan tartsák.
A termékdokumentáció fejlesztésének sok mozgó része van, de itt most kettőre mutatunk rá közülük:
-
Ki érti a termék működését minden szinten (ez magában foglalja a termékfejlesztési és specifikációs csapatokat is).
-
Azok, akik a termékdokumentációt átnéző ügyfelektől kapnak inputot, és meghallgatják az adott termékdokumentáció megértésével kapcsolatos nehézségeiket, visszajelzéseiket és aggályaikat.
Az első rész segít abban, hogy a rendelkezésre álló ismeretekkel elkészítsük a kiosztott termékdokumentációt, és ezt kiküldjük az ügyfeleknek, akik cserébe visszajelzést adnak, és elindítják a második folyamatokat, amelyek segítenek a dokumentáció optimalizálásában.
Néha ez a két pont nincs tökéletesen a helyén, és ez olyan helyzeteket eredményez, amikor a termékdokumentáció sosem kapja meg a szükséges figyelmet.
Az egyik megközelítés az, hogy kijelölünk egy személyt, aki felelős a, termékdokumentáció, termék kézikönyvek és felhasználói útmutatók "teljesítményéért". Tekintsünk egy olyan megrendelést, amelynek a "termékdokumentáció" a terméke. Ő felelős azért, hogy végigmenjen a vállalat összes csapatán, felvázolja, hogy az egyes termékek hogyan generálják az útmutatóikat, és meghatározza az ezzel a folyamattal kapcsolatos kihívásokat.
A szándék nem az, hogy ez a terméktulajdonos és termékmenedzser teljes mértékben felelős legyen az útmutatók létrehozásáért és módosításáért, hanem az, hogy segítse az egyes csapatokon belüli egyének munkáját a dokumentumkezeléssel.
Ennek az egyénnek meg kell vizsgálnia, hogy a felhasználók hogyan lépnek kapcsolatba a dokumentumokkal, fel kell ajánlania a frissítések gördülékenyebbé tételének módjait, és visszajelzéseket kell gyűjtenie annak meghatározása érdekében, hogy hogyan lehet az egyes termékek dokumentációját és magyarázóit a célközönséggel együtt fejleszteni.
Ha valaki felelős a termékdokumentáció minden aspektusáért, a munkafolyamatok és a dokumentáció elkészítéséhez szükséges különböző részlegek irányításáért, az növeli a termelékenységet a vállalaton belül, tudatosságot teremt, és az ügyfeleket tudásportálokkal oktatja a termékről, és összességében racionalizálja a termék megértését.
Tekintsen a termékdokumentációra úgy, mint magára a termékre.
A termékek azért léteznek, hogy olyan értéket nyújtsanak, amely megfelel vagy meghaladja az ügyfél elvárásait. A D2WorldWide által generált statisztikák alapján az emberek 73,7%-a hasznosabbnak ítéli a dokumentációt, mint a videókat, a csomagolást vagy az eladókat, amikor információt keresnek olyan termékekről, amelyek megvásárlását fontolgatják.
Vegyük figyelembe azokat a tényezőket, amelyek hozzájárulnak egy termék vonzerejéhez. Számos tényező befolyásolhatja egy termék vonzerejét, de e cikk kedvéért háromra fogunk koncentrálni. Túlszárnyalják az elvárásokat értékük tekintetében; használatuk elégedettséget generál; és versenyképesek.
Ezenkívül ugyanezek a fogalmak vonatkoznak a jó online termékdokumentációra is. A "várt értéket meghaladó" termékdokumentumok nemcsak azt mutatják be, hogyan kell használni a megadott terméket, hanem olyan megoldásokat is kínálnak, amelyekről az ügyfél nem tud, vagy amelyeket nem tart lehetségesnek. Mindig látni kell, hogy más vállalatok hogyan indítják el a termékdokumentációjukat, hogy tanulhassunk sikereikből és hibáikból.
Semmi értelme annak, hogy egy vállalat egyedi és kiváló minőségű szoftvereket fejleszt, amelyek megelőzik a versenytársakat, ha a fejlesztők és az ügyfelek, akik integrálják az Ön műszaki termékdokumentációit, nem képesek megérteni azokat.
Gondoljon arra, hogy a termékdokumentációt olvasó személy esetleg nem ismeri a termék által kínált lehetséges megoldások körét vagy a piacot (ahogyan ez a technikai SaaS-termékek esetében gyakran előfordul), ezért "oktatni" kell őt ezekről a megoldásokról és a termékkel kapcsolatos különböző lehetőségekről.
Azok a termékdokumentumok, amelyek "használhatósága elégedettséget generál", a célközönségnek megfelelő logikus olvasási mintát követnek. Hiába a világ legátfogóbb kézikönyve, ha az egy 500 oldalas PDF, vagy nem tartalmaz kódpéldát, és nem dinamikusan, keresési lehetőségekkel és egyéb funkciókkal van létrehozva. Gyűjtsön visszajelzést a termékdokumentum felhasználóitól és a támogató személyzetétől. Ők fogják megállapítani a jelentett adatokkal kapcsolatos főbb stresszhelyzeteket.
Azok a termékdokumentációk versenyképesek, amelyeket folyamatosan frissítenek a leghatékonyabb információcsere-technikák alkalmazásával. Olyan csodálatos funkciókkal rendelkeznek, mint a beépített keresési lehetőségek, fordítások, különböző verziók, beágyazott képek, videók és még sok más!
Még ha az Ön integrációs útmutatója a legjobban megírt is az összes technológiai vállalkozás közül, hiányzik belőle a vonzerő egy hozzáadott videó, valamint képek és kódok nélkül, amelyek másolhatók és beilleszthetők a könnyebb használat érdekében a technikai tudású ügyfelek számára, akik megvásárolják a technikai SaaS-termékeit.
Mindig látni kell, hogy más cégek hogyan indítják el a dolgozatukat, hogy tanulhassunk a sikereikből és a hibáikból.
Értelmetlen, ha egy cég egyedi és kiváló minőségű szoftvert fejleszt, amely megelőzi a versenytársakat, ha a fejlesztők és az Ön dokumentumait integráló ügyfelek nem képesek azokat teljes egészében felfogni.
Termékdokumentációs visszajelzés
A hatékony műszaki termékdokumentáció javítja a végfelhasználói élményt azáltal, hogy csiszolja a termékek megértésének folyamatát, és könnyen elérhető írásos megoldásokkal diagnosztizálja az esetleges problémákat. Ha az ügyfelek bíznak és megértik, hogyan kell használni az Ön termékeit, akkor a jövőben visszatérhetnek Önhöz, ha szükség van rá.
Az SDL által készített új kutatás azt mutatja, hogy a dokumentáció szerepe a világpiacon egyre nagyobb szerepet játszik. A kutatás azt mutatja, hogy a vásárlók mintegy 53%-a a műszaki szakirodalom alapján vásárol, mielőtt egyáltalán kipróbálná a terméket. A kutatás egy másik statisztikája azt is mutatja, hogy a vásárlók 94%-a úgy érzi, hogy a termékinformációk egyetlen helyen történő elhelyezése hasznos és hasznos. Emiatt manapság minden vállalat ugyanolyan nagy hangsúlyt fektet a termékdokumentációra, mint a termékfejlesztésre vagy tesztelésre.
Még ha a dokumentációnak van is kijelölt tulajdonosa, aki a dokumentációs csapatot irányítja, és olyan termékdokumentációt készítettek, amelyet a jobb használhatóság érdekében felülvizsgáltak és értékeltek, valamint megfelelően frissítettek, akkor is továbbra is küszködik azzal, hogy a felhasználók és a fogyasztók megértsék műszaki termékeit. Ez abból adódhat, hogy a felhasználók/olvasók nem képesek megérteni, hogyan olvassák a dokumentumait, vagy milyen kérdéseket tesznek fel valójában. Emiatt a dokumentumszerkesztés egyik legnagyobb kihívást jelentő szempontja az, hogy az olvasó helyébe képzelje magát. Végül is, bárki is készíti a termékdokumentációt, annak alaposan ismernie kell a terméket.
Ez a szakértelem arra késztetheti az írót, hogy figyelmen kívül hagyjon olyan dolgokat, amelyek az átlagfelhasználó számára nem annyira nyilvánvalóak. Tipikusan ez akkor fordul elő, amikor valami, ami a terméket készítő emberek számára magától értetődő, nem teljesen világos a terméket vásárlók és használók számára.
Ez többféleképpen történhet:
Az írás szerkezete vagy formája: Bár ez szubjektív szónak tűnhet, még a kézikönyv megírásának módja is okozhat zavart. Lényeges, hogy meghatározzuk, milyen olvasó olvassa a dokumentációt; ellenkező esetben előfordulhatnak olyan szavak, mint "A fejlesztők a példákat részesítik előnyben a leíró szöveggel szemben" vagy "Dokumentációnk a példák és a vizuális elemek jelenléte ellenére sem egyértelmű".
A kézikönyvekben szervezett téma: Előfordul, hogy az ugyanazon a piacon működő vállalkozások szabványosított dokumentációs formátumot dolgoznak ki. Ha az Ön vállalati kézikönyvei nem tartják be ezt, az olvasónak furcsa érzése támadhat.
Az implicit kifejezések túlzott használata: Egy kézikönyvben alkalmazva a rövidítéseknek kevés értelme lehet, még akkor is, ha a kifejezések nem rövidítések. Nehéz érzékelni, de egyes szavak, mint például a "státusz", "azonosító", "megbízólevél", és explicitnek álcázott implicit jelentést tartalmaznak. Használjon sajátos elnevezéseket, például "UserID", és ne "UID".
Hiteles fordítás: A fordítás hatalmas része a globális elérésnek. Sokszor előfordul, hogy a vállalatok rosszul lefordított felhasználói kézikönyveket és termékdokumentációkat készítenek, amelyek nem felelnek meg bizonyos nemzetek kultúrájának, vagy egyszerűen a szavak nem ugyanúgy fordíthatók le, mint ahogyan az angol nyelven lefordítanák az adott ország számára. Ezeknek a finom árnyalatoknak a megértése hosszú utat tehet meg a termékdokumentációt az olvashatatlan információktól a teljesen átfogó és lefordított termékdokumentációig.
Az ilyen helyzetek elkerülése érdekében olyan megoldás kifejlesztése a cél, amely összegyűjti és elemzi a felhasználói visszajelzéseket és a navigációs mintákat.
Az olyan visszajelző eszközök, mint a Vocally a Docsie funkció, nagyszerű lehetőséget nyújtanak a navigációs mintázatok újrafelvételére és értékelésére, valamint annak felmérésére, hogy ügyfelei hogyan tekintik meg a termékdokumentációt. A visszajelzések gyűjtésének 7 aranyszabálya itt olvasható.
Ez az információ kritikus fontosságú a felhasználói útmutatók, felhasználói kézikönyvek és termékdokumentáció frissítéséhez és optimalizálásához, hogy zökkenőmentesebb élményt nyújtson ügyfeleinek a termékek megismeréséhez. Semmi sem frusztrálóbb, mint egy új termék bevezetése, és felfedezni, hogy megnövekedett a támogatási kérelmek száma a rossz kézikönyvbeli utasítások miatt.
Hogyan írjunk átfogó termékdokumentációt?
A minőségi termékdokumentáció magával ragadó, hasznos és erőteljes. Azt állítom, hogy az ügyes dokumentáció a jó termékmenedzsment elengedhetetlen eleme. Bármennyire is nagy szerepet vállalnak a termékmenedzserek a termékfejlesztésben, a siker jelentős része a lenyűgözően csiszolt termékdokumentáció létrehozása, amelyet ügyfeleink megérthetnek és felhasználhatnak a termékeinkkel kapcsolatos ismereteik bővítésére.
Mi történik a legtöbb termékdokumentációval?
Sok termékmenedzser idegenkedik a termékdokumentumok elkészítésétől. Az általuk ismert termékdokumentumok nem biztos, hogy vonzóak lesznek az ügyfelek számára, hacsak nem fordítanak nagyobb gondot arra, hogy vonzóvá, könnyen olvashatóvá és érthetővé váljanak.
Sokszor azonban a vállalatok nem fordítanak kellő gondot a lenyűgöző termékdokumentáció létrehozására és kidolgozására. A gyenge termékdokumentációt kizárólag azért írják, hogy megírják. Kiterjedt, homályosan elfogadható gondolatokkal teli kifejezéseket és rossz elrendezést alkalmaz, hogy a nézőket elriassza az anyaggal való interakciótól. A rossz termékdokumentáció azért készül, hogy megvédje a szerzőt a kritikától, és mindenki idejének teljes elvesztegetése. És az ügyfeleik is emiatt nem szeretik olvasni.
Hogyan javítsuk ezt ki, és írjunk jobb termékdokumentációt, amelyet az ügyfeleink szívesen olvasnak?
A kiváló termékdokumentációt azzal a szándékkal írják, hogy olvassák. Rövid és tömör. A jó termékdokumentáció jól formázott, és a vállalat vagy az ügyfelek számára három perc alatt mindenki elolvasható és megérthető. Kerüli a szakzsargont, és vagy üzleti szintű nézőpontot ad meg, vagy arra utal. A kiváló termékdokumentáció időt fordít a konkrét felhasználási esetek felvázolására, amelyeket az ügyfelek megérthetnek és alkalmazhatnak a termék fokozott használatára. Magával ragadja az olvasót, és jól kidolgozott megoldásokkal hívja fel a figyelmet a mögöttes problémákra.
A jól megírt termékdokumentáció ereje
Ahol kis-, közép- vagy nagyvállalatok vannak, ott a jól megformázott műszaki termékdokumentáció sok időt takaríthat meg, és segíthet az alkalmazottaknak a produktívabb munkavégzésben. Ez általában igaz a legtöbb termékalapú vállalkozásra, amelyek költségvetésük nagy százalékát fordítják műszaki írók alkalmazására és műszaki termékdokumentáció írására.
Ha vállalkozása két főnél többet foglalkoztat a termékdokumentáció készítésére, a jó dokumentáció kultúrájának kialakítása teljesen megérte. Számos oka van annak, hogy miért szeretné, ha csapata jól kidolgozott termékdokumentációt készítene, kezelne és publikálna, de az alábbi részben azzal foglalkozunk, hogy a hatékony termékdokumentáció hogyan jelent alacsony költségű megközelítést az ügyfélélmény javítására.
A hatékony termékdokumentáció alacsony költségű megközelítés az ügyfélélmény javításához
A szilárd ügyfélélmény a hűséges ügyfelek megtartásának és megtartásának előterében áll. A legtöbb projektmenedzser optimista - kapnak egy koncepciót, lelkesednek, majd végrehajtják. Bár a lelkesedés csodálatra méltó, és a végrehajtás produktívnak tűnik, létfontosságú, hogy a megfelelő termékdokumentáció végrehajtása előtt legyen egy játékterv.
A játékterv ötletelését követő első lépések a tervezési ciklus elindítása és a termékdokumentáció tartalmának olyan módon történő strukturálása, hogy az fokozatosan könnyen olvasható legyen az ügyfeleik számára.
Az ügyfelek visszajelzésének megszerzése a jelenlegi dokumentációról szintén létfontosságú lépés, hogy a dokumentációt az ügyfelek igényeinek megfelelően át lehessen strukturálni. Így a projektmenedzserek érzékeléssel és automatizálással hozhatják létre, kezelhetik, karbantarthatják, közzétehetik és optimalizálhatják dokumentációjukat. Ez nem egyszerű és aprócska feladat, és az olyan csodálatos eszközök, mint a Docsie amelyek automatizálnak egy csomó folyamatot a termékdokumentáció hatékonyabbá tételéhez, nagyon fontosak a sikerhez.
A vonzó, vonzó és navigálható műszaki dokumentáció segít a fogyasztóknak abban, hogy rövidebb idő alatt megtanulják a terméket, ami növeli annak valószínűségét, hogy helyesen állítják be a terméket és helyesen használják azt.
A jól kidolgozott termékdokumentáció létrehozásának mindezek a stratégiái lényegében magasabbra értékelt termékekhez, kedvezőbb értékelésekhez és több értékesítéshez vezetnek, mindezek egymáshoz kapcsolódnak, ezért magától értetődő, hogy a megnövekedett értékesítés ennek eredményeként.
Hogyan készítsünk jól kidolgozott termékdokumentációt?
Hogyan készítsünk hatékony dokumentációt, és hogyan ápoljunk olyan kultúrát, ahol ez a szabvány? Hatékony dokumentációt írni nagy kihívás, de a Docsie -ban sok jó funkció van, amelyek segíthetnek elvetni ezt a folyamatot, hogy jól megmunkált és dinamikus termékdokumentációs portálokat készítsünk. Az alábbiakban egy magas szintű összefoglaló arról, hogyan közelítjük meg a kérdést.
Most pedig kezdjük el:
Az oldalhatárok biztosítják az olvashatóságot. Egy tisztességes dokumentumot nem szabad, hogy nehéz legyen olvasni és mentálisan feldolgozni. Az elhúzódó, kanyargós mondatok gyakran az áttekinthetőség hiányára utalnak. Ha a közleményt nem lehet megfelelően összefoglalni egyetlen oldalon, az azt jelzi, hogy a termékmenedzsernek valószínűleg vissza kellene mennie és tovább kellene bontania a helyzetet.
A formátumozás javítja a minőséget. A rosszul strukturált termékdokumentáció növeli annak a valószínűségét, hogy az író szárnyalni fog. Hozzon létre egy sablont jól formázott szakaszokkal, táblázatokkal és dokumentumfejlécekkel. Ez egy egyszeri befektetés, nagy osztalékpotenciállal.
A sablonok segítségével időt takaríthat meg. Sokkal könnyebb törölni egy szakaszt egy sablonból, mint emlékezni arra, hogy hozzáadjon egyet. Nem lekezelő, hanem hatékony és időtakarékos. Az egyszerű szakaszok, amelyek emlékeztetik az írót arra, hogy a széleskörű háttérrel kezdje, és a mérések vagy a veszélyes feltételezések tekintetében pontosabban fogalmazzon, pontosabb írást és döntési hierarchiát tesznek lehetővé.
Kommentálás és feladatkiosztás Nincs biztosabb módja annak, hogy demotiválja munkatársait a magas színvonalú dokumentáció készítésétől, mint az, hogy nem tesz megjegyzéseket. A megjegyzéseknek nem kell nagyon okosnak lenniük; inkább az elkötelezettséget kell jelezniük, és mintaként kell szolgálniuk. Bár ideális, ha digitálisan ad visszajelzést, hogy a cégen belül mások is aszinkron módon profitálhassanak a beszélgetésből, a Docsie-ban egy egyszerű funkció, amely lehetővé teszi, hogy kommentáljon és együttműködjön a csapatával, nagyszerűen működik a termékdokumentációs csapat!
Nézze meg ezt a blogot, hogy többet megtudjon arról, hogyan segít a Docsie a termékdokumentációs együttműködésben
https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/
A dokumentumtípusoknak skálázhatónak kell lenniük, hogy megfeleljenek a vállalat igényeinek. Ahogy egyre több érdekelt fél vesz részt a termékfejlesztési folyamatban, a kommunikációt több dokumentumra kell osztani (különösen, ha az egyoldalas "tömörség" kritériumát teljesíteni akarjuk). A Docsie hasznos és fenntartható megoldást tesz lehetővé a növekvő termékdokumentációs csapatok számára.
Használja a Docsie-t a fantasztikus termékdokumentáció létrehozásának felgyorsítására.
A Docsie egy nagyon praktikus platform, amely a termékdokumentáció és a tudásportálok létrehozásának minden aspektusában segít. Számos beépített funkcióval rendelkezik, amelyekkel a termékdokumentáció-kreálási projektek létrehozása, közzététele, karbantartása és kezelése igazán egyszerűvé és szórakoztatóvá válik! Íme, csak néhány a Docsie számos olyan funkciója közül, amelyek segíthetnek a fenti célok elérésében:
Szerkesztési lehetőség: A Docsie lehetővé teszi minden felhasználónk számára, hogy a közzététel után szerkessze a termékdokumentációt egy alternatív verzió létrehozásával, amely addig nem élesedik, amíg nem lesz aktív. Ez azért nagyszerű, mert a termékmenedzsment csapatok dolgozhatnak a termékdokumentáció szerkesztésén és módosításán, majd élesre állíthatják, amint készen állnak rá, anélkül, hogy HTML-, és CSS-korlátokon kellene átugraniuk. Ez automatikusan megjeleníti a termékdokumentációt egy gombnyomással, amikor készen állnak.
Keresési lehetőség: Ha a termék dokumentációja bőséges, vagy sok funkció van, a Docsies kereső plugin hasznos bónusz, amely lehetővé teszi ügyfelei számára, hogy gyorsan és egyszerűen keressenek a dokumentációban, hogy megtalálják a szükséges információkat, hogy felgyorsítsák a folyamatot, amelyben előnézeti és elnyeli az információkat a termékdokumentációból.
Kapcsolódási lehetőség: Docsie SEO-baráttá teszi a termékdokumentációt. Visszalinkelhet a vállalat weboldalának bizonyos oldalaira, vagy egyszerűen csak a termékein alapuló kulcsszavakat írhat, amelyek online kereshetőek lesznek, és vonzzák az új ügyfeleket, akik ugyanazt a terméket keresik, amelyik a helyén van.
Képesség a különböző fordításokhoz: A Docsies legmodernebb szellemfordítója lehetővé teszi felhasználóink számára, hogy termékdokumentációjukat különböző nyelvekre fordítsák le. Emellett a Docsie nyelvválasztó funkcióival ügyfelei kiválaszthatják, hogy melyik nyelv felel meg nekik a legjobban. Ez rendkívül hasznos a globális elérés és a vállalatok ügyfélkörének bővítése érdekében, miközben bizalmat építenek újonnan alapított ügyfeleikkel és tengerentúli ügyfeleikkel.
Feladatok és megjegyzések hozzárendelésének lehetősége a zökkenőmentes együttműködés érdekében: A Docsie csodálatos eszközökkel rendelkezik a termékdokumentációs csapatával való együttműködéshez. Hozzászólásokat rendelhet hozzá, feladatokat állíthat be és szerepeket rendelhet ki, így jobban tudja kezelni, hogy melyik felhasználó milyen feladatokat végez el, aki a Docsie-vel a termékdokumentációs projektjén dolgozik. Ha többet szeretne megtudni, nézze meg ezt a blogot itt.
Feedback generálás: Az egyetlen módja annak, hogy megtudja, mit gondolnak az ügyfelei a dokumentációjáról, hogy hogyan optimalizálhatja a termékdokumentációját az ügyfelei igényeinek megfelelően, hogy azok minél élvezetesebben érthessék meg a termékdokumentációját és a tudásportálokat Ha többet szeretne megtudni a termékdokumentációs visszajelzések fontosságáról, kérjük, nézze meg a blogomat itt.
Sok más funkció és képesség is van, amit a Docsie lehetővé tesz az Ön és termékmenedzsment csapata számára, hogy elképesztő termékdokumentációt készítsen. Ebben a cikkben szeretnék beleugrani azokba a bővítményekbe, amelyeket minden Docsie tudásportál és termékdokumentáció hozzáadhat a dokumentációjához, hogy javítsa azokat és javítsa az általános használhatóságukat.
Docsie bővítmények a dokumentációs portál dinamikusabbá tételéhez!A Docsie-nak egy csomó bővítménye van, amelyekkel még vonzóbbá teheti dokumentációját. Ebben a blogban 3 részre osztom.
Ebben a részben ezeknek a tudásportál pluginoknak a magyarázatát három részre osztjuk.
PART 1: Az első részben megmutatjuk, hogy mit mutatunk be a 'Display Version Picker', a 'Display Language Picker', a 'Display Section Anchors' és a 'Display Footer Navigation'.
PART 2: Ebben a részben megmutatjuk a 'Kódkiemelés', a 'Keresés' és a 'Megosztás a közösségi hálózaton' plugint.
PART 3: A harmadik részben bemutatjuk a 'Képelőnézet', a 'Dokumentum metaadatok' és az 'Automatikus szakaszkiemelés' plugint.
Mielőtt belevágnánk a bővítményekbe, beszéljünk arról, hogyan lehet ezeket a bővítményeket elérni a Docsie Platformon belül.
Először is, a munkaterületen belül a jobb felső sarokban lévő három pontra kell kattintanunk, és meg kell nyitnunk a fiókunkat:
Ezután a Deployments-en belül hozzáférhetünk a Plugins-hoz, miután létrehoztunk egy új Deployment-et a 'Configure a new deployment+' menüponton keresztül.
Ezután kattintson a 'További opciók' gombra, amely lehetővé teszi, hogy ezeket a bővítményeket hozzáadja a telepített dokumentációjához egy beágyazott szkript segítségével vagy a Docsie portálon keresztül.
A másik lehetőség a Docsie tudásportálok bővítményeinek elérése a már közzétett dokumentáció alatt található 'Update deployment configuration' gombon keresztül.
Megnyitja ezt a műszerfalat, és ezután hozzáadhat vagy elvehet pluginokat, ahogy jónak látja, majd frissítheti a telepítést.
1. RÉSZ:
Most, hogy már tudjuk, hogyan érjük el a Docsie Pluggin-t, ugorjunk bele az PART 1-be.
Az 1. rész **videós bemutatójának megtekintéséhez kérjük, nézze meg ezt a videót itt:
kezdjük a 'Display version Picker'-rel és a 'Display Language Picker'-rel.
Ha ez a kettő aktív, akkor a tudásportál bal alsó sarkában lebegő fülekként jelennek meg. Ezek lehetővé teszik ügyfelei és a termékdokumentációt olvasók számára, hogy különböző nyelveken és verziókban tekintsék meg a termékdokumentációt.
Amint a felhasználó megnyomja a Nyelv a nyelvválasztón belül, a teljes dokumentáció, amit olvas, átváltozik az adott nyelvre.
A szakaszok megjelenítése horgony aktiválás után lehetővé teszi az ügyfél számára, hogy az egyes fejlécek mellett olyan linkek legyenek, amelyek a dokumentáció bizonyos szakaszaira mutató hivatkozásokat adnak.
Minden alkalommal, amikor ezeket a linkeket megnyomja, a fejléc egy része megváltozik, és amikor az ügyfél másolja és beilleszti ezt a html-t, a dokumentáció ezen speciális részéhez irányítja a személyt, akinek elküldi.
A következő a 'Lábléc navigáció megjelenítése'
Ez a bővítmény egy navigációs gombot ad a dokumentáció Könyvének jobb alsó sarkában. Valahogy így néz ki.
Így ügyfelei kényelmesebben navigálhatnak a dokumentációban.
2. RÉSZ:
A 2. rész videós bemutatójának megtekintéséhez kérjük, nézze meg ezt a videót itt:
Ebben a részben a 'Kódkiemelés', a 'Keresés' és a 'Megosztás a közösségi oldalakon' plugin-t mutatjuk be.
Kezdjük a 'Code Highlighting' pluginnal
Ez a bővítmény kiválóan alkalmas olyan műszaki termékekhez, amelyeknek különböző kódokat kell kifejezniük ügyfeleik számára. Ez a plugin lehetővé teszi ügyfeleik számára, hogy másolják és beillesszék a kiosztott kódot, hogy a "Másolás" gomb hozzáadásával könnyebbé tegyék a szerkesztőjükön való használatot.
Most merüljünk el a Search pluginben.
Miután aktiválta a Docsie tudásportálján, ügyfelei a tudásportál jobb felső sarkában található kereső navigáció segítségével kereshetnek a dokumentációjában.
A keresésre kattintva ez egy kifinomult műszerfalat fog megjeleníteni, amely lehetővé teszi az ügyfelei számára, hogy pontosan meghatározzák, hol találnak meg bizonyos információkat a polcon és a könyveken belül.
Ez nagymértékben felgyorsítja azt a folyamatot, amelyben az ügyfelei megtalálhatják és lekérdezhetik a szükséges információkat az Ön termékeiről.
A következő a Share To Social Networks plugin
Ez a bővítmény lehetővé teszi ügyfelei számára, hogy megragadják az írott termékdokumentációjának kiemelt részeit, és megosszák azt a közösségi médián belül.
Ez azért nagyszerű, mert növelheti a forgalmat, az új potenciális ügyfeleket és összességében a márkád iránti bizalmat.
3. RÉSZ:
A 3. rész videós bemutató megtekintéséhez kérjük, nézze meg ezt a videót itt:
A harmadik részben a 'Kép előnézet', 'Dokumentum metaadatok' és az 'Automatikusan kiemelő szakasz' bővítményt mutatjuk be.
Kezdjük a képelőnézeti pluginnal
A képelőnézet lehetővé teszi ügyfelei számára, hogy a termékdokumentáció képét nagyítsák vagy kicsinyítsék a jobb megtekintés érdekében.
Következik a 'Dokumentáció metaadatok'
ez lehetővé teszi ügyfeleink számára, hogy lássák az időbélyegzőt, amikor a termékdokumentáció vagy a tudásportál szempontjai frissültek. Ez az írásbeli dokumentáció tetején és alján található.
Most nézzük meg az 'Auto-Highlight Section Plugin'-t
Ez az egyszerű plugin lehetővé teszi ügyfelei számára, hogy nyomon kövessék, hol tartanak egy adott dokumentációban a tudásportálon belül.
A Tudásportálon belül kiemeli az egyes helyeket, így a yo8ru ügyfelei jobban nyomon követhetik, hogy melyik szekcióban vannak, és könnyebben navigálhatnak más szekciókhoz.
Mindezeket az eszközöket és még sok mást is biztosít számodra a Docsie platformja. Ha még nem próbálta ki, javasoljuk, hogy tegye meg. Kattintson ide
Továbbá, ha bármilyen kérdése van, kérjük, forduljon hozzánk bizalommal a hello@docsie.io