Nézze meg a Docsie Teams kedvenc dokumentációs példáit, és azt, hogyan lehet ezeket a példákat a saját tudásportálján megismételni.
A dokumentáció a termékfejlesztési folyamat szerves része. Ahogy a termék a koncepció bizonyításából a valóságba kerül, a magyarázó dokumentáció elengedhetetlen ahhoz, hogy az ügyfelek megtanulják, hogyan használják a terméket.
Mik az első dolgok, amelyeket egy ügyfélnek tudnia kell, amikor kiválaszt egy terméket? Mire való, mit csinál, és hogyan kell csinálni? Vegyük példaként a Docsie-t!
A Docsie egy termékdokumentációs platform. Lehetővé teszi a felhasználók számára, hogy dokumentációt hozzanak létre, szerkesszenek, jegyzeteljenek és tegyenek közzé egy online tudásportálon. Ez olyan egyszerű, mint bejelentkezni, létrehozni egy új Docsie Bookot, és begépelni az első tartalmat!
Bevalljuk, mi egyszerűen tartottuk. A termékdokumentáció esetében azonban az összetett funkciók és funkciók átfogóbb magyarázatot igényelnek, hogy a koncepciót a gyakorlatban is megismertessük.
Ebben a cikkben a Docsie-csapatok 10 kedvenc példáját mutatjuk be a lenyűgöző termékdokumentációra. Még jobb? Azt is megmutatjuk, hogyan készíthetsz magad is lenyűgöző termékdokumentációt (a mi lenyűgöző példáink által inspirálva!).
Merüljünk el! 🤿
10 elképesztő termékdokumentációs példa
Az alábbiakban 10 elképesztő termékdokumentációs példát találsz, amelyeket a Docsie csapata választott ki. Megvizsgáljuk, hogyan lehet a funkciókat és funkciókat lemásolni, és hasonlóan elképesztő saját dokumentációt készíteni a Docsie-ban!
1 - Docker
A Docker egy konténervirtualizációs platform, amely lehetővé teszi a szoftverek apró, moduláris és egyedileg elszigetelt IT-környezetekben történő tárolását. A koncepció lehetővé teszi, hogy több, egymástól eltérő szolgáltatás egyetlen gazdasoros operációs rendszeren legyen hosztolható azáltal, hogy az operációs rendszer erőforrásait felosztja és megosztja a konténerek között.
A Docker termékdokumentációs portálján jól áttekinthetően formázott termékdokumentáció található, és minden olyan alapvető információt bemutat, amely a Docker-konténerek letöltéséhez, telepítéséhez és használatba vételéhez szükséges. Többnyelvű termékdokumentációt, API-referenciadokumentációt és egy gyakran ismételt kérdéseket (GYIK) tartalmazó részt is megoszt a portál alján. A vizuálisan tanulók számára a jobb alsó sarokban egy videós rész is található.
A Kezdő lépések szakasz létrehozásához használjuk példaként a Docsie-t. A Docsie-ban való induláshoz létre kell hoznia egy fiókot, meg kell erősítenie az e-mail címét, be kell töltenie a Docsie Workspace műszerfalat, létre kell hoznia egy új polcot, létre kell hoznia egy új könyvet - ennyi volt az alap! Hozzon létre egy keretet az egyes szakaszok fejléccíméből, írjon utasításokat, adjon hozzá képeket és hiperhivatkozásokat, és a végén az alábbihoz hasonló szerkezetet kap!
A legjobb rész? Docsie ezt automatikusan elvégzi helyetted!
Nézze meg, hogyan történik ez a Docsie-ban, olvassa el a Docsie gyorsindítási útmutatóját!
2 - Stripe
A Stripe egy nemzetközi fizetési feldolgozási platform, amelynek technikai funkcionalitása lehetővé teszi az egyéni integrációkat és fizetési paramétereket a Stripe parancssori felület (CLI) használatával. Küldetésnyilatkozata az internet GDP-jének növelése az e-kereskedelmet racionalizáló virtuális gazdasági infrastruktúra kiépítésével.
Ez a Stripe oldal technikai termékdokumentációként ismert. Feltárja, hogyan használhatunk egy CLI-t Docker-konténerek létrehozására (helló újra!) és a Stripe-pal való kommunikációra, kizárólag terminálparancsok használatával. Az oldalon tartalomjegyzéket, másolás-beillesztés funkcióval ellátott kódblokkokat és szöveges hiperhivatkozásokat láthat.
A Docsie rendelkezik kódblokkokkal, ezért vizsgáljuk meg, hogyan használhatjuk őket
Nézze meg ezt a kódblokkok példáját a Docsie-ban
Másoljuk ki ezt a kódot, hogy kövessük a példánkat -
console.log('Hello World');
Nyissunk meg egy Docsie könyvet a Docsie szerkesztőben. Az alábbi GIF megmutatja, hogyan kell megtalálni a Code Block opciót az eszköztáron, és tartalmaz egy JavaScript példát, amely kiírja a "Hello World!" szöveget.
A Docsie portálján a kódkiemelés a technikai olvasók számára az áttekinthetőség javítása érdekében kerül alkalmazásra. A felhasználók még a kódot is bemásolhatják a praktikus vágólap ikon segítségével!
Nézze meg, hogyan alkalmazza a kódkiemelő bővítményt a Docsie-ban!
3 - Apple
A mindenütt jelenlévő Apple! Nem, nem az ehető fajta!
Az Apple kiváló termékdokumentációt kínál népszerű iPhone okostelefon-családjához. Az Apple termékdokumentációra vonatkozó példánkban van verzióválasztó, tartalomjegyzék, szöveg és fejléc, végül pedig soron belüli képek.
Fedezzük fel a verziókezelést a Docsie-ban!
A Docsie tudásportálon található dokumentáció olvasásakor az olvasók a verzióválasztó bővítmény segítségével választhatnak ki egy verziót.
Ez lehetővé teszi az olvasók számára, hogy megtekinthessék a korábbi termékdokumentációt - tudja, azoknak a lassú piszkálóknak, akik még nem frissítettek!
Új verzió létrehozásához a Docsie-ban használja a Docsie Editor verziókezelő lapját.
Itt kattintson a Add version + gombra.
Ezután válasszon ki egy verziószámot és egy verziónevet, mielőtt az Add version gombra kattint. Ez ilyen egyszerű! Frissítse az új verzió dokumentumot a funkcióváltozásokkal, és hagyja, hogy ügyfelei megtalálják a legfrissebb (vagy késői) információkat!
4 - Parse
A Parse egy kiváló full stack szoftverplatform, amely nyílt forráskódú keretrendszereket biztosít az alkalmazások háttértárához. Egyszerűen olyan előre elkészített kódforrásokat kínál, amelyekben a fejlesztők megbízhatnak, amikor bármilyen fejlesztési projektbe integrálják.
A Parse dokumentációs portálon egy nagyszerű dokumentációs példa található kompatibilitási táblázatok formájában. Ez figyelemmel kíséri a különböző architektúrák, például a Node.js és a MongoDB kompatibilitását a Parse platformmal.
Készítsük el ezt Docsie-ban!
A Parse példájához hasonló négy oszlopos táblázatot készíthetünk a Docsie-ban található táblázatblokkok segítségével.
Válassza ki a táblázatblokk ikont, majd a négy oszlop opciót.
Gépelés közben az Enter billentyűvel mozogjon az oszlopok mentén. A Ctrl + B billentyűkombinációval tegye félkövérré a szöveget. Végül adjon hozzá emojikat a szimbólum opció segítségével.
Ez egy egyszerű módja az API dokumentáció és a technikai szoftverdokumentáció megírásának. Tovább mehet a Node.js weboldalra mutató hiperhivatkozásokkal vagy a vonatkozó felhasználói kézikönyvekre mutató belső hivatkozásokkal. Adja ki a következő API-kompatibilitási táblázatát a Docsie-ban!
5 - Flutter
A Flutter a Google által létrehozott UI-eszközkészlet, amely a felhasználói felület tervezésének konzisztenciáját segíti elő mobil, webes, asztali és beágyazott eszközökön. Online kódszerkesztővel segíti elő a gyors UI-tervezést és -fejlesztést, a réteges konténer-alapú architektúra pedig teljes testreszabást tesz lehetővé.
A Flutter számos videót ad otthont a felhasználók számára, amelyeken megnézhetik és megismerhetik a platformot. Mivel a platformot a Google készíti, a YouTube logikus választás a példánkhoz!
Ezt a dizájnt a Docsie-ban is leutánozhatod a videó beágyazási blokkok segítségével!
Egyszerűen kattintson a Docsie Book-on belül, válassza ki a videó beágyazás ikonját, majd másolja be a YouTube URL-t a szövegmezőbe. Ugyanezt megteheti a Dailymotion, a Vimeo és számos más videohoszting weboldal esetében is.
Van egy GIF, amely bemutatja ezt a folyamatot, így saját videókat is hozzáadhat a Docsie-hoz - próbálja ki!
6 - Ionic keretrendszer
Az Ionic Framework egy nyílt forráskódú UI-eszközkészlet, amellyel HTML, CSS, JavaScript és más webes technológiák felhasználásával készíthetünk teljesítményt nyújtó asztali és mobilalkalmazásokat.
Olyan népszerű keretrendszerekkel integrálódik, mint az Angular, a React és a Vue, különböző UI-komponensekkel, natív eszközfunkciókkal és téma-támogatással.
Az Ionicnak van egy nagyszerű mobiltelefonos példája beágyazva az oldalára. Adjunk hozzá egy hasonló példát a Docsie könyvünkhöz iFrame beágyazás segítségével!
Először is másoljuk ki az alábbi kódot:
<iframe loading="lazy" importance="low" src="https://ionic-docs-demo.herokuapp.com/?ionic:mode=ios"></iframe>
Ezután kattintson a kód beágyazási blokkjára a Docsie Editorban. Illessze be ide az iFrame beágyazási kódot, majd kattintson a Mentés gombra a folytatáshoz. Az alábbiakban egy GIF illusztrálja ezt a folyamatot.
Tekintse meg az iFrame-ot használó integrációk hivatalos listáját a Docsie-ban!
7 - DigitalOcean
A DigitalOcean egy felhőalapú számítástechnikai szolgáltatási platform, amely lehetővé teszi az ügyfelek számára, hogy szervereket, virtuális gépeket, adatbázisokat és egyebeket üzemeltessenek. Dedikált Kubernetes-szolgáltatásokat kínál skálázható konténeralkalmazásokhoz, valamint menedzselt megoldásokat webtárhelyekhez, mobilalkalmazásokhoz, nagy adattavakhoz és VPN-szolgáltatásokhoz.
A DigitalOcean a felhasználói visszajelzések gyűjtése és a tartalom iterálása érdekében visszajelzési funkciót kínál a dokumentumaiban. Fedezzük fel, hogyan lehet ezt a Docsie-ban megtenni!
A Vocally a Docsie-ban a visszajelzések gyűjtésének megfelelő funkció. Lehetővé teszi a felhasználók számára, hogy csillagértékelést, szöveges visszajelzést és akár videofelvételt is hagyjanak - édes!
Itt elérheti a Docsie Vocally bármelyik beküldött visszajelzését. A felhasználóknak lehetőségük van 1-5 csillaggal történő értékelésre és rövid szöveges magyarázatra. Egyes felhasználók hajlandóak lehetnek képernyőfelvételt is hagyni, ami segít a probléma pontos meghatározásában!
Minden Docsie-ügyfél hozzáférést kap a Vocallyhöz, és ez felbecsülhetetlen értékű a dokumentáció erősségeinek és gyengeségeinek feltárásában. Nem mindig sikerülhet elsőre jól, de a következő iterációnál még jobban sikerülhet, ha az írói a Docsie Vocallyt használják!
8 - Slack
A Slack vitathatatlanul az üzleti világ Whatsappjává vált. A népszerű üzleti azonnali üzenetküldő (IM) platform hang- és videohívásokat, kép- és GIF-megosztást, kommentválaszfákat és egyebeket kínál az üzleti kommunikáció megszervezésére és egyszerűsítésére.
A Slack az egész dokumentációs portálján tooltipeket kínál a fontos információk kiemelésére, és a kapcsolódó funkciók kiemelésére. Másoljuk meg ezt a Docsie-ban!
A fentihez hasonló tooltipet készíthetünk idézőblokkok segítségével a Docsie-ban.
A különböző Docsie szerkesztőgombok használatának megtanulása
Egyszerűen navigáljon a Docsie Editor eszköztárra, és válassza ki az idézetblokk ikonját. Itt választhat információs, figyelmeztető vagy kérdéses blokk típusokat. Ezt az alábbi animált GIF-ben szemléltetjük.
Íme néhány variáció az infó, figyelmeztetés és kérdés idézet blokkok használatával egy élő Docsie portálon. A kérdés- és figyelmeztető blokkokat emellett kérdés-felelet kijelentések létrehozására is használhatja - használja ki kreativitását az idézetblokkok használatával a következő Docsie Book-ban!
9 - Rozsda
A Rust egy olyan programozási nyelv, amelyet a sebesség szem előtt tartásával terveztek. Meg tudja előzni a szegfaultokat és garantálja a processzorszálak biztonságát. A Rust használható REST-API keretrendszerek létrehozására, olyan adatbázis-megoldásokkal való kommunikációra, mint a PostgreSQL, és még sok másra.
A Rust Standard könyvtár soron belüli kódrészleteket tartalmaz, amelyek az API dokumentáció böngészésének egyszerűsítésére szolgálnak. Párosítsuk a Docsie-ban!
A soron belüli kódrészletek közé tartozik a Vec<T> és az Option<T> . Ezt a Docsie-ban a markup gomb segítségével tehetjük meg.
A szöveg kódként való jelöléséhez egyszerűen csak kattintsunk és húzzuk a szöveget, majd kattintsunk a jelölés gombra. Ezt a folyamatot az alábbiakban egy GIF illusztrálja.
A jelölő szöveg hiperhivatkozásokat is tartalmaz. Ennek a linknek át kell irányítania egy szószedetre, amely elmagyarázza, hogy mit csinál a kódrészlet.
Vegyen egy gyorstalpaló tanfolyamot a hiperhivatkozások készítéséről a Docsie-ban.
10 - Yoast
A Yoast egy keresőmotor-optimalizálási (SEO) platform, amelyet arra terveztek, hogy segítsen a vállalkozásoknak optimalizálni WordPress oldalaikat, és fejlessze a SEO legjobb gyakorlatokkal kapcsolatos ismereteiket. A Yoast SEO plugin optimalizálja a webhelyeket a Google keresőmotorok találati oldalain (SERPS) való jobb teljesítmény érdekében, hogy növelje az ügyfelek elkötelezettségét.
A Yoast dokumentációs portálján lépésről lépésre útmutatókat kínál a listacímek segítségével. Ezt megismételhetjük a listafejlécekkel a Docsie-ban!
Ehhez a Docsie-ban először hozzon létre egy Könyvet, és nyissa meg a Docsie szerkesztőt.
Ezután kattintson a szövegmezőre, és válassza ki a Docsie-szerkesztő eszköztárában a listafejléc opciót. Az alábbiakban egy GIF-fel illusztráljuk ezt a folyamatot.
A listafejlécek a HTML specifikáció részét képezik. A Docsie-ban a listafejlécek nagyszerűek, mivel lehetővé teszik közvetlen hivatkozások létrehozását a dokumentáción belül. Ez azt jelenti, hogy amikor a felhasználók egy linkre kattintanak, egyenesen a lista fejlécéhez jutnak (ahelyett, hogy görgetniük vagy lapozniuk kellene!).
Használja ezeket a Docsie funkciókat a saját előnyére! 🏆
Ez a 10 dokumentációs példa megmutatja, milyen hasznosak lehetnek a felhasználói útmutatók. Legközelebb, amikor felhasználói útmutatót készítesz, használd ezeket a Docsie tippeket és trükköket az előnyödre! Az általunk kiválasztott példák nagyszerűek, de tudjuk, hogy a tiéd még jobb lesz! 📐👌
A Docsie egy végponttól végpontig terjedő dokumentációkezelő platform, amelyet a vállalkozások webes GYIK, termékdokumentációk, felhasználói útmutatók, súgó-dokumentumok és felhasználói kézikönyvek készítésére használnak. A platform ügyfélközpontú együttműködést, széles körű beágyazást, testreszabott fordításokat és erőteljes publikálást kínál az Ön keze ügyében.
Kezdje el a beszállást még ma, és nyújtson élvezetes digitális dokumentációt a Docsie-val!