A szoftverdokumentáció írása szerves szerepet játszik a programozó munkájában. Ahogy mondani szokás, ha nincs dokumentálva, akkor nem is létezik, és a legtöbb esetben a kód megfelelő dokumentálása ugyanolyan fontos, mint a tényleges megírása. „Bármilyen csodálatos is a könyvtára, és milyen intelligens a kialakítása, ha Ön az egyetlen, aki érti, az nem tesz jót. A dokumentáció nemcsak automatikusan generált API-referenciákat jelent, hanem megjegyzésekkel ellátott példákat és részletes oktatóanyagokat is. Mindháromra szükség van ahhoz, hogy könyvtárát könnyen átvehesse” – mondta Nicholas Zakas, egy jól ismert front-end mérnök és könyvszerző. Ezért ma úgy döntöttünk, hogy megnézzük a legjobb és leggyakrabban használt szoftverdokumentációs és műszaki írási eszközöket.
Súgó szerzői eszközök
A segítőkészítő eszközök nagy szerepet játszanak a szoftverdokumentációban és a műszaki írásban, mivel jelentősen megkönnyítik a szoftverdokumentáció tervezését, írását, közzétételét és karbantartását. Lehetővé teszik, hogy csökkentse az időt és az erőfeszítést, amikor mindenféle segédanyagot készít, mind a végfelhasználók, mind a programozók/alkalmazottak számára.
A MadCap Flare az egyik legnépszerűbb súgószerkesztő eszköz, köszönhetően a szolgáltatások gazdag választékának, amelyek sokkal többet tesznek lehetővé, mint a súgódokumentáció írása. A MadCap Flare-t fejlett témaalapú szerkesztésre, egy forrásból történő közzétételre és tartalomkezelésre tervezték. Lehetővé teszi súgó és ügyfélszolgálati webhelyek, GYIK, tudásbázisok, online oktatási központok, útmutatók, irányelvek és eljárási kézikönyvek és egyebek létrehozását. A MadCap Flare funkciói megkönnyítik ugyanazon tartalom több csatornán történő újrafelhasználását és gyors közzétételét számos platformon.
A Document360 egy másik széles körben használt webes platform, amely lehetővé teszi mindenféle tudásbázis és súgóanyag létrehozását, közzétételét és frissítését. Többprofilú funkciókkal is rendelkezik, beleértve az egyszerű Markdown szövegszerkesztőt, a Kategóriakezelőt a tudásbázis struktúrájának felépítéséhez, a céloldal testreszabási szolgáltatásokat, a verziók visszaállítását, a biztonsági mentést és visszaállítást, a rugalmas szerepkörök és engedélyek beállítását és így tovább.
Az Adobe RoboHelp egy másik hatékony alternatív súgószerkesztő eszköz, amely a MadCap Flare-hez és a Document360-hoz képest némileg eltérő funkciókat kínál. Különösen az Adobe RoboHelp kínál egyszerű többformátumú közzétételt, lehetővé téve a tartalom közzétételét számos népszerű kimeneti formátumban, beleértve a keret nélküli reszponzív HTML5-t, PDF-t, a Microsoft Help (CHM) és a még ritkábban elterjedt formátumokat, például EPUB 3, KF8 és MOBI.
A Help+Manual fő előnye az egyszerű felület, amely nagyon hozzáférhetővé és könnyen használhatóvá teszi, valamint a WYSIWYG XML szerkesztő teljes funkcionalitását, a többcsatornás közzétételt, a multimédiás és összetett moduláris projektek teljes támogatását, valamint a webhelp eszközt a zökkenőmentes integrációhoz. dokumentációt az aktív webhelyekre, és így tovább.
A ClickHelp emellett meglehetősen hatékony webes platformot biztosít a szoftverdokumentációhoz tudásbázisok, GYIK, oktatóanyagok és más súgóformátumok formájában. Több formátumot támogat, például Word, HTML, RTF, CHM, ODT, CHM, HTML5 webes súgó, PDF, DOCX stb. A ClickHelp néhány jellemző funkciója szabadalmaztatott teljes szöveges keresés, amely megkönnyíti a konkrét témák vagy cikkek megtalálását. szerzők és felhasználók, valamint számos előre elkészített sablon közül választhat a dokumentáció tervezéséhez.
Képernyőrögzítő eszközök
A legtöbb szoftverdokumentációnak és súgóanyagnak tartalmaznia kell képernyőképeket, ezért érdemes röviden áttekinteni a legjobb képernyőrögzítő eszközöket.
Ha Windowst használ operációs rendszerként, akkor egy Snipping eszközzel rendelkezik, amely lehetővé teszi képernyőképek készítését a teljes képernyőről, külön ablakokról vagy a képernyő egy részéről, és a toll eszközzel kiemelheti a képernyőkép egyes részeit.
A FireShot egy népszerű böngészőbővítmény, amely nagyjából az összes modern böngészőt támogatja, mint például a Chrome, a Firefox, az Internet Explorer és az Opera. Lehetővé teszi a teljes weboldal vagy annak egy meghatározott részének rögzítését.
A SnagIt egy összetettebb képernyőrögzítő eszköz. Lehetővé teszi bármely oldal görgethető területeinek rögzítését, valamint videórögzítés támogatását. Ezzel a képpel GIF-eket is készíthet, és meghatározott műveletsorokat rögzíthet a képernyőn.
Helyesírás- és nyelvhelyesség-ellenőrző
Az is fontos, hogy a dokumentáció helyesen legyen megírva, nyelvtani és írásjel-hibák nélkül. Íme néhány eszköz, amelyek segítenek megtalálni a hibákat a szövegekben és kijavítani azokat.
Az egyik legnépszerűbb ingyenes online helyesírás- és nyelvhelyesség-ellenőrző. Az írnokok több mint 250 különböző típusú hibát tudnak azonosítani és kijavítani, beleértve a főneveket, névmásokat, elöljárószavakat, igéket, homonimákat, írásjeleket, tipográfiát és így tovább.
A szövegek elírási és hibáinak megjelenítése mellett a Grammar.com releváns javaslatokat, valamint nyelvtani szabályokat és e-könyvet kínál az írás javítása érdekében (mindent ingyenesen).
„Bármilyen csodálatos is a könyvtára, és milyen intelligens a kialakítása, ha Ön az egyetlen, aki érti, az nem tesz jót. A dokumentáció nemcsak automatikusan generált API-referenciákat jelent, hanem megjegyzésekkel ellátott példákat és részletes oktatóanyagokat is. Mindháromra szükség van ahhoz, hogy könyvtárát könnyen átvehesse” – mondta Nicholas Zakas, egy jól ismert front-end mérnök és könyvszerző. Ezért ma úgy döntöttünk, hogy megnézzük a legjobb és leggyakrabban használt szoftverdokumentációs és műszaki írási eszközöket.
GO TO FULL VERSION