Te is feltörekvő műszaki író vagy, aki most szeretne belevágni, de nem tudja, milyen eszközöket használjon az írás dokumentálásához? Nos, akkor a legjobb helyen jár!
Először is, értsük meg, mi is pontosan a műszaki dokumentáció
Az embernek dokumentálnia kell a folyamatát, és ezért a műszaki dokumentum az egyik fontos tényezőnek számít, amely hozzájárul egy szoftverprojekt sikeréhez.
Egy műszaki dokumentum megértéséhez nem kell doktori fokozatot szerezni, egyszerűbb szavakkal és mérnöki szempontból a műszaki dokumentáció minden olyan típusú dokumentációra utal, amely leírja egy műszaki termék vagy bármely más, fejlesztés alatt álló vagy használatban lévő termék kezelését, funkcionalitását és architektúráját.
A dokumentáció terjedhet egy egyoldalas követelménylaptól egy új nyílt forráskódú keretrendszert dokumentáló vastag referencia kézikönyvig.
Mára az alkalmazások, API-k, SDK-k, sőt a legtöbb hardvertermék dokumentációja is elérhető online.
Felsoroltam a legjobb technikai dokumentációs eszközöket linkekkel együtt, hogy jobban megismerje és megértse őket, kezdjük el, jó?
A HelpNDoc egy könnyen használható, mégis nagy teljesítményű szerzői eszköz, amely sokoldalúan alkalmazkodik a különböző igényekhez, különböző dokumentációs formátumokat képes létrehozni egyetlen forrásból.
A HelpNDoc minden szükséges eszközt biztosít a teljes súgófájlok, kézikönyvek és dokumentációk írásához egy felhasználóbarát és nagyon könnyen használható környezetben.
Szokásos Windows CHM súgófájlokat, WEB alapú dokumentációt, iPhone specifikus weboldalakat, valamint nyomtatható PDF és Word dokumentumokat képes létrehozni.
Jellemzők
– A HelpNDoc lehetővé teszi az író számára, hogy egyetlen forrásszöveget hozzon létre, amelyet aztán számos célformátumba konvertál, mint például HTML súgó, PDF, RTF, DocX, Qt Help és HTML dokumentáció, valamint EPUB és Amazon Kindle kompatibilis e-könyvek.
– Képes továbbá kódot generálni a C++, Delphi, Fortran, Pascal és Visual Basic programozási nyelvekhez, hogy a generált CHM súgófájlokat integrálni lehessen a fejlesztendő alkalmazásba.
– A 4. verzió óta a HelpNDoc egy projektelemzővel is rendelkezik, amely képes nyomon követni a dokumentum elrendezését, statisztikákat szolgáltatni és azonosítani a lehetséges problémákat, például a törött linkeket vagy a médiaelemekkel kapcsolatos problémákat.
- A HelpNDoc mobil weboldalak közzétételére is használható, a tartalomjegyzéket navigációs menüként, a témakörök tartalmát navigációs gombokkal, a kulcsszóindex menüt, a beépített keresőmotort és a mobil-specifikus felhasználói felület elemeit használva.
https://www.helpndoc.com/
#2 ClickHelp
Kéne egy sokféle funkcióval rendelkező dokumentációs eszköz, akkor a ClickHelp az Öné. A ClickHelp egy modern, böngészőalapú dokumentációs eszköz, amely könnyen beállítható és használható, nem igényel telepítést, webböngészőben fut, és több platformot is támogat: Mac OS, Windows és Linux, ami megkönnyíti a dokumentáció írását a világ bármely pontjáról.
A szoftvercégek világszerte a ClickHelp-t használják online felhasználói kézikönyvek, tudásbázisok, súgófájlok, GYIK-ek, útmutatók készítésére és azonnali közzétételére a portáljukon.
Jellemzők
-Napi biztonsági mentések- A ClickHelp napi biztonsági mentéseket biztosít, így megbizonyosodhat arról, hogy adatai biztonságban vannak
– Fejlett analitika- A ClickHelp saját integrált analitikával rendelkezik, amely segít az aktuális helyzet elemzésében, és segít a dokumentációs folyamat előre tervezésében is.
– Ember által olvasható projekt URL-ek- Ez a funkció nem csak az emberek, hanem a keresőmotorok számára is hasznos, és segít a dokumentáció SEO-jában
-Social Media Sharing Buttons- Könnyedén megoszthatja dokumentációját a különböző közösségi médiumokban.
-Review Notes for topics- Az átnézés az a szakasz a dokumentáció írási folyamatában, amelyet egy csapat sem hagyhat ki. A ClickHelp nem csak a felülvizsgálati jegyzetek funkciót kínálja, hanem egy speciális felülvizsgálati szerepet is.
-Powerful Topic Editor- Minden műszaki író szereti a jó szövegszerkesztőt, a ClickHelp Word-szerű funkciókat és még többet kínál, hogy kényelmes munkakörnyezetet biztosítson.
- Integrációk- A ClickHelp lenyűgöző integrációs lehetőségeket kínál, például : Zendesk, AddThis, Disqus, Google Analytics, Google Search Console, Azure AD SSO, Google SSO, Salesforce SSO, YouTube, Vimeo, Gravatar, Screencast.com stb.
https://clickhelp.com/
#3 Whatfix
Interaktív útmutatót szeretne létrehozni a platformján? A Whatfix a megfelelő eszköz az Ön számára.
A Whatfix egy digitális adoptációs platform, amely segít a vállalatoknak az alkalmazások felhasználóinak beillesztésében, képzésében és támogatásában.
AWhatfix lehetővé teszi, hogy kontextusfüggő és testreszabott tartalmat hozzon létre és nyújtson áramlatok, súgó tippek, videók, linkek és szövegek formájában, mindezt alkalmazáson belüli élményként
AWhatfix használható tartalom létrehozására bármilyen webalapú vállalati alkalmazáson, például Salesforce, SAP SuccessFactors, Oracle HCM Cloud stb. egyedi webes alkalmazásokon és a fogyasztók számára készült webhelyeken.
A Whatfix emellett támogatja a felhőalapú és a saját üzemeltetésű telepítési módot is.
Tulajdonságok
-Multiböngésző kompatibilitási API
-Interaktív felhasználói útmutatók
-Self-Hosting
-Data Analytics
-User Tracking
-Multi útmutató formátum, beleértve videókat, grafikákat, képeket és szövegeket.
– Testreszabható felhasználói felület
#4 ProcessStreet
A ProcessStreet a legegyszerűbb módja az ismétlődő munkafolyamatok kezelésének a csapata számára. Ráadásul segít gyorsan hozzárendelni az ellenőrzőlistás munkafolyamatokat a csapatához.
A ProcessStreet egyszerű felülettel rendelkezik, amelynek segítségével pillanatok alatt létrehozhat egy strukturált dokumentumot. Ráadásul a műszerfalon nyomon követheti a tevékenységet, és értesít, ha a feladatokat elvégezte.
Ez az otthona csapata folyamatdokumentumainak, intuitív billentyűparancsainak és a drag and drop funkciónak köszönhetően bárki számára könnyen használható.
Jellemzők
-Feltételes logika- A feltételes logika használatával valóban dinamikus ellenőrző listákat hozhat létre, ha/akkor logikával, amely alkalmazkodik a csapata változó igényeihez.
-Űrlapok használata strukturált adatok rögzítéséhez- Az űrlapok segítségével strukturált adatokat gyűjthet az ellenőrző listáiban. Adja be az adatokat manuálisan, vagy küldje el azokat az Ön által kiválasztott alkalmazásokba és azokból.
-szabályalapú munkafolyamat
-Kollaboratív munkaterület
Végezetül
A műszaki dokumentáció különböző típusaihoz különböző szoftverek állnak rendelkezésre, a célközönségtől függ, hogy melyiket választja. Érzékelnie kell, hogy melyik az, amelyik a leginkább vonzza, és csak rajta, ha már elkezdte, bármikor eldöntheti, hogy melyik az ideális az Ön számára!