Tovább folytatjuk, ahol a műszaki írói eszközök sorozat 1. részében abbahagytuk. (Nézze meg, ha még nem olvasta)
Ebben a részben az “Információ dokumentálása” fázisban használt műszaki íróeszközökkel foglalkozunk.
Ez az írás, szerkesztés, rajzolás, felülvizsgálat és újraírás fázisa. Ez az a fázis, amikor az információs dokumentációs csapat teljes erőbedobással ontja magából az útmutatókat, kézikönyveket, blogokat, videodemókat, online súgóoldalakat és miegymást. Tekintettel az ebben a fázisban felmerülő feladatok sokféleségére, az alkalmazott technikai írói eszközök is igen változatosak és számtalanok.
Top 17 műszaki írói szoftvereszköz a dokumentációhoz 2020-ban
-
- Whatfix
- MediaWiki
- Adobe Robohelp
- Notepad++
- WordPress
- Adobe Photoshop
- Adobe Illustrator
- Microsoft Visio
- Windows Snipping Tool
- Windows Movie Maker
- Powtoon
- Prezi
- Microsoft Word
- Kingsoft WPS Office
- Google Docs
- Adobe Framemaker
- oXygen XML Author
1. Whatfix
A Whatfix paradigmaváltást jelent a súgó dokumentáció online megjelenítési módjában. A statikus és hosszú webes súgóoldalak nem ragadják meg a felhasználó figyelmét olyan hatékonyan, mint a Whatfix által bemutatott interaktív, képes útmutatók, amelyeket népszerűen “ballonoknak” neveznek.
A mai világban ráadásul az online súgónak különböző eszközökön – legyen szó PC-ről, táblagépről vagy okostelefonról – kell elterjednie. A Whatfix automatikusan hozzáigazítja a súgó tartalmát az adott gadgethez. És ugyanaz a súgó tartalom különböző formákban is elérhető – diavetítés, PDF vagy videó formájában.
A szerző tippje: A Whatfix támogat egy egyedülálló funkciót – Valós idejű interaktív ismertető -, amelyben a súgó részleteket közvetlenül az élő termékoldalra helyezheti! A felhasználó elolvassa a snippetet a Whatfix ballonban, és ennek megfelelően végrehajtja a műveletet az oldalon. Ez egy népszerű technikai írói eszköz a hagyományos módszertanoktól való eltérést kereső vállalkozások körében.
MediaWiki
A termék online súgójának wiki oldalaként való megjelenítése egyszerű és hatékony ötlet. Oldalaidat közvetlenül a Wikipédiába is integrálhatod, ha nincs külön weboldalad az online termékedhez. Alternatív megoldásként a wikiszerű súgóoldalakat a termék weboldalán is elhelyezheti. Ennek a formátumnak az online felhasználók körében való nagyfokú ismertsége kulcsfontosságú előny, és a MediaWiki Visual Editor ingyenes wikiszerkesztő eszközzel a súgó létrehozása igen egyszerűvé válik.
A MediaWiki egy PHP-alapú webszerkesztő eszköz, amelyet a Wikipedia is használ. Azonban még a nagy szoftvercégek is – az Intel az egyik legfontosabb példa – ezt az eszközt használják értékesítési és marketing információik, használati utasításaik, valamint az irányelvekről és eljárásokról szóló segédoldalak bemutatására.
A szerző tippje:
Adobe RoboHelp
Egy iparági szabványos szerzői eszköz, amelyet asztali vagy webes alkalmazások súgórendszereinek létrehozására használnak. A RoboHelp egyetlen számítógép-felhasználó számára sem idegen! Valahányszor megnyomja az F1 billentyűt bármelyik szabványos szoftveralkalmazásban, a megjelenő súgóablakot szinte mindig a RoboHelp segítségével hozza létre. Ugyanakkor a hagyományos, nyomtatásra szánt műszaki dokumentáció, például útmutatók és kézikönyvek előállítására is használható.
A kifinomult RoboHelp IDE lehetővé teszi a műszaki írók számára, hogy nagyszabású súgóprojekteket fejlesszenek ki, és azokat több hardvereszközön/operációs rendszeren és több formátumban (PDF, HTML, DOC stb.) megjelenítsék. A RoboHelp régebbi verziója olcsó kiadásként is megvásárolható, ha a költségvetés korlátozza. A kisvállalkozások azonban maradhatnak az egyszerű, ingyenes alternatíváknál, mint például a WordPress blogok vagy Wikik. A jó öreg MS Word is képes alapvető HTML súgófájlokat generálni Önnek.
A szerző tippje: A rendszeres frissítési verziókkal rendelkező nagy szoftvertermékek kezelése komoly kihívást jelenthet a műszaki írók számára, mivel szinkronban kell lenniük a termékváltozások történetével. A súgófájlok gyakran olyan konfigurálható, felhasználó által meghatározott változókat mutatnak, amelyek többször ismétlődnek a súgó dokumentációban. (Például egy olyan változó, mint az “Alvási idő inaktivitás után” 30 másodpercre van beállítva az előző verzióban, amelyet a frissítésben 1 percre kell beállítani.) A RoboHelp projekt gondoskodna a változó értékének frissítéséről a súgófájlokban!
Notepad++
Egy nagyon hatékony kezdő HTML-szerkesztő. A legtöbben ezen a technikai íróeszközön tanulják meg a HTML-programozás alapjait. Ha az Ön szoftverterméke nem igényel nagyon nehéz online súgó dokumentációt, közepes méretű súgófájlok készítéséhez ez az eszköz több mint elegendő.
A testreszabható felhasználói felülete lehetővé teszi a könnyű szerkesztést, támogatja a WYSIWYG nyomtatást, és többnyelvű támogatási lehetőségekkel is rendelkezik.
A szerző tippje: A Notepad++ gazdag bővítménykészlettel rendelkezik. Multi-clipboard, Code Compare, Auto-Save néhány népszerű közülük. A műszaki íróknak ki kell választaniuk a megfelelő bővítmények készletét, amelyek egy közönséges kezdő szerkesztőt az online súgószerkesztés életképes lehetőségévé alakíthatnak.
WordPress
A GoTo hely, ha blogok formájában szeretne műszaki dokumentációt készíteni a termékéhez. A WordPress egy nyílt forráskódú, ingyenes, online tartalomkezelő platform. A WordPressen írt blogok vagy közvetlenül a WordPress blog URL-címéről érhetők el, vagy integrálhatók a vállalati webhelybe.
Ez a cikk maga a Whatfix Academy nevű WordPress blogon található. Ha a cél az, hogy rendszeresen publikáljon online tartalmat a vállalatáról/ a kapcsolódó technológiákról, akkor hozzon létre egy WordPress blogfiókot. A blogok a felhasználók reakcióit is rögzíthetik kommentek és kedvelések formájában, ami megkönnyíti a célközönséggel való kapcsolattartást, és érzékelteti a termék iránti megbecsülésüket.
A szerző tippje: A blogok önmagukban nem biztos, hogy elegendő szemet szednek össze. Tehát először írja meg a blogját, ezután népszerűsítse a blogját a közösségi médiaplatformokon, végül pedig mérje a nézettséget/visszajelzéseket, mielőtt nekilátna a következő blogsorozatnak!
Szintén olvasd: Hogyan változik a műszaki írás az idővel
Adobe Photoshop
Egy eszköz, amelyre a legtöbb műszaki író az egész iparágban esküszik. Ez a világ legnépszerűbb képszerkesztő eszköze fotók és raszter (pixel) alapú műalkotások létrehozására és szerkesztésére. Felhasználói felületi tervek, weboldalak, bannerhirdetések, videografikák, nyomtatásra szánt képek szerkesztésére használható. Egy kép manipulálása, egy kép egymásra helyezése, egy fénykép finomítása a tökéletlenségek kiküszöbölésére, a megvilágítási problémák korrigálása a legnépszerűbb felhasználási módjai. A képszerkesztési folyamat visszafordítható és fokozatos, így a változtatások könnyen visszaállíthatók.
A szerző tippje: A professzionális tervezők számára, akiknek folyamatosan szükségük van egy képszerkesztő eszközre, szinte semmi sem helyettesítheti az Adobe Photoshopot. Ha azonban alkalmi felhasználó vagy, próbáld ki a GIMP-et, amely nyílt forráskódú. Ez ugyanis csak az RGB színsémákat támogatja, míg a Photoshop a CMYK (CYAN YELLOW MAGENTA BLACK) színmódot is támogatja. És a GIMP tanulási görbéje magasabb, de ingyenes, míg a Photoshop egy bombába kerül!
Adobe Illustrator
Vektoralapú illusztrációk, például logók és márkajelzések vagy más tervezési elemek létrehozására és szerkesztésére szolgáló eszköz. A grafikusok gyakran elkövetik azt a hibát, hogy terméklogóikat Photoshopban tervezik. De ugyanazt a logót kell kinyomtatni a névjegykártyákra, valamint a hatalmas reklámtáblákra is. Tehát a kép méretezése az áttekinthetőség elvesztése nélkül itt a kulcs, amit a vektorgrafika alapú képalkotó eszközökkel érnek el. Az Adobe Illustrator és a Corel Draw a vezető technikai íróeszközök technikai íróeszközök ezen a téren.
A szerző tippje: Ez az eszköz az Adobe Creative Cloud megoldás része, amelynek drága havi bérleti díja van. Az ingyenes alternatív műszaki íróeszközök, mint az Inkscape vagy az Affinity Designer ugyanolyan jól elvégzik a munkát SVG-formátumokkal. Hacsak nincs szüksége a megoldás részét képező összes fontosabb műszaki íróeszközre (Photoshop, InDesign stb.), akkor ez az eszköz nem kötelező darab.
Microsoft Visio
A műszaki alkalmazások tervezésénél használt népszerű diagramkészítő eszköz. A műszaki íróknak gyakran kell folyamatábrákat, építészeti diagramokat, elektromos áramköri diagramokat, szoftvertermék-tervezést stb. tervezniük. A Visio kényelmes segédeszköz ehhez.
Ez egy IEEE-konform műszaki íróeszköz, amely megfelel az olyan szoftveripari szabványoknak, mint az UML (Unified Modeling Language) és a BPMN (Business Process Model and Notation).
A szerzők tippje: A Visio nem volt része a hagyományos Microsoft Office csomagnak, mindig is külön-külön árulták, hasonlóan az MS Projecthez. A Microsoft egy nagyon friss bejelentése szerint azonban az Office 365 online előfizetői mostantól a Visiót is elérhetik.
Windows Snipping Tool
Ha olyan képernyőfelvételi lehetőségeket keres, amelyek kifinomultabbak, mint a billentyűzetén lévő PrntScr, a Snipping Tool jó választás. A teljes képernyő rögzítése mellett szabadkézi kivágásokat vagy részleges képernyőterületi kivágásokat is készíthet. A videókból álló képek rögzítéséhez használja a késleltetés opciót, így a pontos képkocka képként menthető.
A szerzők tippje: A program a Windows szoftvercsomag része, de előfordulhat, hogy a Windows egyes kiadásaiban alapértelmezés szerint nem engedélyezve van.
Windows Movie Maker
Egy egyszerű videószerkesztő eszköz, amellyel a műszaki írók termékdemó videókat készíthetnek. A Windows Essentials csomag részét képezi. Azonban 2017 januárja óta ez a szoftver megszűnt, megfelelő helyettesítő program bejelentése nélkül. Tehát mindazok a felhasználók, akik régebbi Windows verziókkal rendelkeznek, köszönjék meg a szerencsecsillaguknak!
A szerzők tippje: A videók és hangkivágások storyboard nézetben, képkockánként rendezhetők és szerkeszthetők. Vagy állóképek sorozata feszíthető ki egy idővonalon. A háttérhangokkal behálózott hangalámondások kifinomult színvonalat kölcsönözhetnek a videóknak.
Powtoon
A műszaki írás egyre inkább vizualitássá válik. Az animált videók kiválóan alkalmasak a felhasználói figyelem megragadására és az üzenet magával ragadó módon történő átadására. A Powtoon egy jó webalapú animációs eszköz, amelyet SaaS termékként értékesítenek. Ezzel az eszközzel ingyenesen készíthetők animált prezentációk és magyarázó videók. Az ingyenes verzióval készített videók azonban “Powtoon” vízjelet viselnek.
A szerzők tippje: Ha a műszaki írás nem hivatalos célokat szolgál, teljesen rendben van, ha ennek az eszköznek az ingyenes verzióját használja. Névleges bérleti díj ellenében azonban beszerezheti a prémium verziót, amely lehetővé teszi a vízjel nélküli videók készítését és számos egyéb funkciót is.
Prezi
Egy rendhagyó módon, videós prezentáció formájában készíthet demókat. A Powerpoint-tal ellentétben, ahol a tartalom mereven diákra van felosztva, a Prezi egyetlen hatalmas üres vásznat ad. Ezen aztán kedvére írhat, rajzolhat rajta. A fókuszban lévő tartalomra ráközelíthetsz vagy elvonatkoztathatsz, és ugyanazon a vásznon egyik képkockáról a másikra helyezheted át a fókuszt – így készíthetsz folyamatos videóbemutatót.
A szerzők tippje: Az ingyenes verzió mellett létezik egy szintén ingyenes diák próbaverzió is, amely a fizetős verzió szinte összes funkcióját tartalmazza. Válassza azt.
Olvassa el azt is – 14 műszaki szövegírói tévhit, amit tudnia kell!
Microsoft Word
Meglehetősen ostobának tűnik a mindenütt jelenlévő MS Wordről írni. De bármennyire is mindennapos a mindennapi digitális életünkben, történetesen mégis a műszaki író legjobb barátja! A PDF- és DOC-formátumok közötti egyszerű konvertálással a Word és az Adobe Acrobat Reader egyszerű kombinációját nem szabad félvállról venni. Lehet, hogy ez a cikk a világ összes csicsás technikai íróeszközéről szól, de ez a cikk – a szerény MS Word segítségével íródott!
A szerzők tippje: Kísérletezzen a Word által kínált különböző dokumentumsablonokkal. Ezek segítenek abban, hogy a dokumentum a rendeltetésének megfelelően nézzen ki – marketing szórólapként, műszaki fehér könyvként, hibaelhárítási útmutatóként és így tovább.
Kingsoft WPS Office
Az MS Word, a PowerPoint és az Excel köztudottan a leggyakrabban használt műszaki szövegíró szoftvereszközök, mérföldekkel megelőzve az elérhető alternatívákat. Egyedül az Android forradalma lassította le egy kicsit az MS Office juggernautát. És előkelő helyet adott a Kingsoft Office-nak, az MS Office ésszerű és ingyenes alternatívájának.
A szerzők tippje: Van néhány árnyalt funkció, amelyet a WPS Writer nem támogat – a tezaurusz az egyik ilyen. A tezaurusz fontos funkció a műszaki írók számára, mivel folyamatosan jobb szavakat keresünk ugyanazon pontok kifejezésére a különböző műszaki dokumentumokban!
Google Docs
Egy olyan világban, amely egyre inkább a praktikus mobiltelefonhoz fordul a dokumentumok olvasásához, ahelyett, hogy a számítógép bekapcsolásával vesződne, a google docs lassan egyre nagyobb teret nyer. A dokumentumok létrehozása a semmiből nem lenne kényelmes a Google Dokumentumokon, de a közös felülvizsgálat és szerkesztés hatékonyan elvégezhető az MS Office e felhőalapú alternatíváján keresztül.
A szerző tippje: A Gmaillel és a Google Drive-val való zökkenőmentes integrációja még vonzóbbá teszi. Műszaki íróként ragaszkodna a kifinomult szövegszerkesztő eszközökhöz. A termékmenedzsere azonban, aki esetleg állandóan úton van, minden valószínűség szerint a telefonján fogja bepótolni az értékeléseit!
Adobe Framemaker
Egy kifinomult dokumentumfeldolgozó nagyméretű, ipari szabványú dokumentumokhoz. XML keretrendszerrel strukturált dokumentumok létrehozására használható, 100%-os DITA-kompatibilitással. Használható strukturálatlan dokumentumokhoz is, az olyan dokumentumszerkesztők helyettesítésére, mint az MS Word.
A Framemaker jó választás strukturált dokumentumok generálására előre definiált sablonokkal, amelyek megfelelnek számos ipari szabványos formátumnak – például jogi megállapodásoknak és pénzügyi kimutatásoknak. Támogatja a TOC vagy index létrehozását több dokumentumon keresztül, gazdag formázási lehetőségekkel rendelkezik. Nem lankad a teljesítménye grafikák beillesztésekor.
A szerző tippje: A Framemaker jó befektetés a hivatalos műszaki szövegíró csapatokkal rendelkező, befutott vállalatok számára, amelyeknek nagy, 100 oldal feletti dokumentumokat kell készíteniük. Az egyetlen termékkel foglalkozó vállalatoknak és az induló vállalkozásoknak azonban nem kell ezt a beruházást megtenniük. Vannak ingyenes, XML-alapú dokumentumszerkesztő eszközök, amelyek ingyenesen elérhetők. És mindig vissza lehet nyúlni a jó öreg MS Wordhöz!
oXygen XML Author
Ez egy ingyenes, nyílt forráskódú, DITA-kompatibilis XML-szerkesztő, számos hűséges felhasználóval és jó véleményekkel. A DITA (Document Information Typing Architecture) a dokumentumszerkesztés és -kiadás nyílt szabványa, amely lassan a műszaki dokumentumkezelésbe is bekerült. Egyszerűen azért, mert megszünteti a tartalomszerkesztés egy adott eszköztől való függőségét. A DITA-kompatibilis online dokumentációt (XML-fájlok halmaza), majd annak szerkesztése és karbantartása a jövőben bármely más DITA-kompatibilis eszközzel lehetséges!
Mivel a DITA-specifikációk olyan terület, amely külön figyelmet igényel, ezt hadd tartogassam egy másik cikkre.
A szerző tippje: Az oXygen Author-t általában az oXygen Developerrel együtt használják.
Ez tehát minden olyan műszaki írószoftver, amelyre a “Dokumentuminformáció” fázisban szüksége lesz. A következő és egyben utolsó részben az “Információ közzététele” fázis következik.
Hogy nagyszerű tippeket kapjon a műszaki íráshoz, és hogy biztosan ne maradjon le a műszaki íróeszközök frissítéseiről, iratkozzon fel a blogunkra.
Tetszik? Tegye könyvjelzőbe a cikket, vagy ossza meg barátaival és kollégáival!
A Whatfixnél megújítjuk a műszaki írás eszközeinek területét azzal, hogy megzavarjuk a hosszadalmas, folyamatos írott tartalom gondolatát. Interaktív útmutatónk segít termelékenyebbé válni azáltal, hogy gyors és hatékony módot biztosít a műszaki dokumentáció létrehozásához. Ebben a cikkben bővebben olvashat arról, hogyan segít a Whatfix a műszaki írásban.
