Free Press

Pokračujeme tam, kde jsme skončili v 1. části seriálu o nástrojích pro technické psaní. (Pokud jste jej nečetli, určitě se na něj podívejte)
V tomto díle se budeme zabývat nástroji pro technické psaní, které se používají ve fázi „Dokumentace informací“
Jde o fázi psaní, editace, kreslení, přezkoumávání a přepisování. V této fázi tým informační dokumentace naplno chrlí průvodce, příručky, blogy, demonstrační videa, stránky online nápovědy a kdovíco ještě. Vzhledem k rozmanitosti úkolů v této fázi jsou i používané nástroje technického psaní poměrně rozmanité a nesčetné.

Top 17 softwarových nástrojů pro psaní technické dokumentace v roce 2020

• • 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. Vydejte se na cestu, kterou vám nabízíme. Whatfix

Whatfix znamená změnu paradigmatu ve způsobu prezentace dokumentace nápovědy online. Statické a zdlouhavé webové stránky nápovědy neupoutají pozornost uživatele tak účinně jako interaktivní obrázkové průvodce prezentované aplikací Whatfix, lidově nazývané „balónky“.
V dnešním světě se navíc online nápověda musí rozšířit mezi různá zařízení – ať už jde o počítače, tablety nebo chytré telefony. Whatfix automaticky přizpůsobuje obsah nápovědy tak, aby vyhovoval danému gadgetu. A stejný obsah nápovědy může být přístupný v různých formách – jako prezentace, PDF nebo video.
Tip autora: Whatfix podporuje jedinečnou funkci – Interaktivní průchod v reálném čase – při níž vložíte úryvky nápovědy přímo do živé stránky produktu! Uživatel si přečte úryvek v balónku Whatfix a provede příslušnou akci na stránce. Jedná se o oblíbený nástroj technického psaní mezi firmami, které hledají posun od tradičních metodik.

MediaWiki

Zobrazení online nápovědy vašeho produktu jako stránky wiki je jednoduchý a efektivní nápad. Pokud nemáte pro svůj online produkt samostatné webové stránky, můžete své stránky integrovat přímo do Wikipedie. Alternativně můžete hostovat stránky nápovědy podobné Wiki na webových stránkách vašeho produktu. Velká známost tohoto formátu mezi online uživateli je hlavní výhodou a díky bezplatnému nástroji pro editaci wiki MediaWiki Visual Editor je tvorba nápovědy poměrně jednoduchá.
MediaWiki je webový editační nástroj založený na PHP, který používá Wikipedie. Tento nástroj však používají i velké softwarové korporace, jako například Intel, k prezentaci svých prodejních a marketingových informací, návodů a stránek nápovědy k zásadám a postupům.
Tip autora:

Adobe RoboHelp

Odvětvový standardní autorský nástroj používaný k vytváření systémů nápovědy pro desktopové nebo webové aplikace. RoboHelp není žádnému uživateli počítače cizí! Pokaždé, když v některé ze standardních softwarových aplikací stisknete klávesu F1, okno nápovědy, které se zobrazí, je téměř vždy vytvořeno pomocí RoboHelpu. Lze jej však použít i k chrlení běžné technické dokumentace pro tisk, jako jsou průvodci a příručky.
Dokonalé prostředí RoboHelp IDE umožňuje autorům technické nápovědy vytvářet rozsáhlé projekty nápovědy a vykreslovat je na různých hardwarových zařízeních/operačních systémech a v různých formátech (PDF, HTML, DOC atd.). Starší verzi RoboHelpu lze zakoupit jako levnou edici, pokud je rozpočet omezen. Malé firmy však mohou zůstat u jednoduchých bezplatných alternativ, jako jsou blogy WordPress nebo Wiki. Starý dobrý MS Word vám také dokáže vygenerovat základní soubory nápovědy HTML.
Tip autora: Správa velkých softwarových produktů s pravidelnými aktualizacemi verzí může být pro technické autory velkou výzvou, protože musí být synchronizováni s historií změn produktu. Soubory nápovědy často zobrazují konfigurovatelné proměnné definované uživatelem, které se v dokumentaci nápovědy několikrát opakují. (Například proměnná jako „Doba spánku po nečinnosti“ je v předchozí verzi nastavena na 30 s, v aktualizaci má být nastavena na 1 min). Projekt RoboHelp by se postaral o aktualizaci hodnoty proměnné v celém souboru nápovědy!“

Notepad++

Velmi efektivní editor HTML pro začátečníky. Většina lidí se na tomto technickém psacím nástroji učí základy programování v HTML. Pokud váš softwarový produkt nevyžaduje příliš náročnou dokumentaci online nápovědy, pro tvorbu souborů nápovědy střední velikosti je tento nástroj více než dostačující.
Jeho přizpůsobitelné grafické rozhraní umožňuje snadné úpravy, podporuje WYSIWYG pro tisk a má také možnosti podpory více jazyků.
Tip autora: Notepad++ je dodáván s bohatou sadou zásuvných modulů. Mezi oblíbené patří Multi-clipboard, Code Compare, Auto-Save. Techničtí autoři si musí vybrat správnou sadu zásuvných modulů, které mohou z obyčejného editoru pro začátečníky udělat životaschopnou možnost pro editaci online nápovědy.

WordPress

Místo GoTo, pokud chcete mít technickou dokumentaci ke svému produktu ve formě blogů. WordPress je bezplatná online platforma pro správu obsahu s otevřeným zdrojovým kódem. Blogy psané ve WordPressu mohou být přístupné buď přímo z adresy URL blogu WordPressu, nebo mohou být integrovány do webových stránek vaší společnosti.
Tento článek sám je umístěn na blogu WordPressu s názvem Whatfix Academy. Pokud je cílem pravidelně publikovat online obsah o vaší společnosti / souvisejících technologiích, pak si zřiďte účet blogu WordPress. Blogy mohou také zachycovat reakce uživatelů v podobě komentářů a lajků, což usnadňuje navázání kontaktu s cílovou skupinou a vnímání jejich uznání pro váš produkt.
Tip autora: Blogy izolovaně nemusí shromáždit dostatečný počet očí. Nejprve tedy napište blog, poté jej propagujte na platformách sociálních médií a nakonec změřte sledovanost/odpovědi, než se pustíte do další sady blogů!“
Také čtěte: Jak se technické psaní mění s dobou

Adobe Photoshop

Jeden nástroj, na který přísahá většina technických spisovatelů napříč oborem. Jedná se o celosvětově nejoblíbenější nástroj pro úpravu obrázků, který slouží k vytváření a úpravám fotografií a rastrových (pixelových) kreseb. Lze jej použít k vytváření návrhů uživatelského rozhraní, webových stránek, reklamních bannerů, video grafiky, úpravám obrázků pro tisk. Manipulace s obrázkem, překrývání jednoho obrázku druhým, vylepšování fotografie za účelem odstranění nedokonalostí, oprava problémů s osvětlením jsou jeho nejoblíbenějšími způsoby použití. Proces úprav obrázků je vratný a postupný, takže změny lze snadno vrátit zpět.
Tip autora: Pro profesionální designéry, kteří neustále potřebují nástroj pro úpravu obrázků, neexistuje téměř žádná náhrada za Adobe Photoshop. Pokud jste však příležitostní uživatelé, vyzkoušejte GIMP, který je open source. Podporuje však pouze barevná schémata RGB, zatímco Photoshop podporuje i barevný režim CMYK (CYAN YELLOW MAGENTA BLACK). A křivka učení je u GIMPu vyšší, ale je zdarma, zatímco Photoshop stojí bombu!“

Adobe Illustrator

Nástroj pro vytváření a úpravy vektorových ilustrací, jako jsou loga a značky nebo jiné prvky designu. Grafičtí designéři často dělají chybu, když navrhují loga svých produktů ve Photoshopu. Stejné logo je však třeba vytisknout na vizitky i na masivní reklamní tabule. Klíčové je zde tedy škálování obrázku bez ztráty přehlednosti, čehož zobrazovací nástroje založené na vektorové grafice dosahují. Adobe Illustrator a Corel Draw jsou v této oblasti předními nástroji pro technické psaní technických textů.
Tip autora: Tento nástroj je součástí řešení Adobe Creative Cloud s drahým měsíčním pronájmem. Bezplatné alternativní nástroje pro technické psaní, jako je Inkscape nebo Affinity Designer, zvládnou práci s formáty SVG stejně dobře. Pokud nevyžadujete všechny hlavní nástroje pro technické psaní, které jsou součástí tohoto řešení (Photoshop, InDesign atd.), není nutné tento nástroj mít.

Microsoft Visio

Oblíbený nástroj pro tvorbu diagramů používaný při návrhu technických aplikací. Techničtí autoři často potřebují navrhovat vývojové diagramy, architektonické diagramy, schémata elektrických obvodů, návrh softwarových produktů apod. Visio je k tomu vhodnou pomůckou.
Jedná se o nástroj pro technické psaní, který je v souladu s normami IEEE a odpovídá standardům softwarového průmyslu, jako jsou UML (Unified Modeling Language) a BPMN (Business Process Model and Notation).
Tip autora: Visio nebylo součástí tradiční sady Microsoft Office, vždy se prodávalo samostatně podobně jako MS Project. Ale zcela nedávné oznámení společnosti Microsoft říká, že online předplatitelé služby Office 365 mají nyní přístup také k aplikaci Visio.

Windows Snipping Tool

Pokud hledáte možnosti snímání obrazovky, které jsou sofistikovanější než PrntScr na klávesnici, je Snipping Tool dobrou volbou. Kromě snímání celé obrazovky můžete snímat také volné výřezy nebo částečné výřezy oblasti obrazovky. Chcete-li z videa zachytit statické snímky, použijte možnost zpoždění, aby bylo možné uložit přesný snímek jako obrázek.
Tip pro autory: Je součástí sady softwaru Windows, ale v některých edicích systému Windows nemusí být ve výchozím nastavení povolen.

Windows Movie Maker

Jednoduchý nástroj pro úpravu videa, který mohou techničtí autoři používat k tvorbě svých demonstračních videí k produktům. Je součástí sady Windows Essentials. Od ledna 2017 je však tento software ukončen, aniž by byla oznámena jeho řádná náhrada. Takže všichni uživatelé se staršími verzemi systému Windows, děkujte svým šťastným hvězdám!
Tip autora: Videa a zvukové výstřižky lze uspořádat a upravovat v zobrazení storyboardu, snímek po snímku. Nebo lze sérii statických snímků roztáhnout na časovou osu. Zvukové voiceovery propojené se zvuky na pozadí mohou dodat videím propracovanost.

Powtoon

Technické psaní se stále více stává vizuálním. Animovaná videa jsou vynikajícím způsobem, jak upoutat pozornost uživatele a předat mu sdělení poutavým způsobem. Powtoon je dobrý webový animační nástroj, prodávaný jako produkt SaaS. Pomocí tohoto nástroje lze zdarma vytvářet animované prezentace a vysvětlující videa. Videa vytvořená pomocí bezplatné verze by však byla opatřena vodoznakem „Powtoon“.
Tip pro autory: Pokud technický text není určen pro oficiální účely, je zcela v pořádku použít bezplatnou verzi tohoto nástroje. Za symbolický pronájem byste si však mohli pořídit prémiovou verzi, která vám umožní vytvářet videa bez vodoznaku a několik dalších funkcí.

Prezi

Netradiční pojetí tvorby ukázek formou videoprezentace. Na rozdíl od PowerPointu, kde je obsah pevně rozdělen do slidů, vám Prezi poskytuje pouze jedno obrovské prázdné plátno. Můžete na něj psát, kreslit, jak se vám zlíbí. Přibližování nebo oddalování zaostřeného obsahu a přesouvání pozornosti z jednoho snímku na druhý na stejném plátně – tak vytváříte souvislou videoprezentaci.
Autorův tip: Kromě bezplatné verze je k dispozici také zkušební verze pro studenty, která je rovněž zdarma a má téměř všechny funkce placené verze. Vyberte si právě tu.
Přečtěte si také – 14 mylných představ o technickém psaní, které byste měli znát!“

Microsoft Word

Psat o všudypřítomném MS Wordu je poněkud hloupé. Ale jakkoli je v našem každodenním digitálním životě běžný, stále bývá nejlepším přítelem technického spisovatele! Díky snadnému převodu mezi formáty PDF a DOC nelze jednoduchou kombinaci Wordu a aplikace Adobe Acrobat Reader brát na lehkou váhu. Tento článek může být o všech fantastických nástrojích pro technické psaní na světě, ale je psán pomocí – skromného MS Wordu!“
Autorův tip: Experimentujte s různými šablonami dokumentů, které Word nabízí. Pomohou vám, aby váš dokument vypadal vhodně pro zamýšlený účel – jako marketingový leták, technická bílá kniha, návod na řešení problémů apod.

Kingsoft WPS Office

MS Word, PowerPoint a Excel jsou známé jako nejpoužívanější softwarové nástroje pro technické psaní, na míle před dostupnými alternativami. Pouze revoluce v systému Android trochu zpomalila žrouta MS Office. A dala přednost Kingsoft Office, rozumné a bezplatné alternativě k MS Office.
Autorův tip: Existuje několik nuancí, které WPS Writer nepodporuje – jednou z nich je tezaurus. Tezaurus je pro technické autory důležitou funkcí, protože neustále hledáme lepší slova pro vyjádření stejných bodů v různých technických dokumentech!

Google Docs

Ve světě, který se stále častěji obrací k praktickému mobilnímu telefonu, aby si přečetl dokumenty, místo aby se obtěžoval zapnutím počítače, se pomalu dostávají do popředí Google Docs. Vytváření dokumentů od nuly by v Dokumentech Google nebylo pohodlné, ale společné prohlížení a úpravy lze prostřednictvím této cloudové alternativy k MS Office provádět efektivně.
Tip autora: Jeho bezproblémová integrace s Gmailem a Diskem Google jej činí ještě atraktivnějším. Jako autor technických textů byste se měli držet sofistikovaných nástrojů pro zpracování textu. Ale váš produktový manažer, který může být neustále na cestách, s velkou pravděpodobností své recenze dohání na telefonu!“

Adobe Framemaker

Sofistikovaný zpracovatel dokumentů pro velké, průmyslově standardní dokumenty. Lze jej použít k vytváření strukturovaných dokumentů s rámcem XML se 100% shodou s DITA. Lze jej použít i pro nestrukturované dokumenty jako náhradu editorů dokumentů, jako je MS Word.
Framemaker je dobrou volbou pro generování strukturovaných dokumentů s předdefinovanými šablonami, které vyhovují několika průmyslovým standardním formátům – například právním smlouvám a finančním výkazům. Podporuje tvorbu TOC nebo rejstříku ve více dokumentech, má bohaté možnosti formátování. Nepodléhá poklesu výkonu při vkládání grafiky.
Tip autora: Framemaker je rozumnou investicí pro zavedené společnosti s formálními týmy technického psaní, které potřebují vytvářet rozsáhlé dokumenty o více než 100 stranách. Společnosti vyrábějící jednotlivé produkty a začínající firmy však tuto investici nepotřebují. Existují bezplatné nástroje pro tvorbu dokumentů založené na XML, které jsou k dispozici zdarma. A vždy se můžete vrátit ke starému dobrému MS Wordu!

oXygen XML Author

Jedná se o bezplatný open source editor XML kompatibilní s DITA, který má několik věrných uživatelů a dobré recenze. DITA (Document Information Typing Architecture) je otevřený standard pro tvorbu a publikování dokumentů, který pomalu proniká do správy technických dokumentů. Jednoduše proto, že odstraňuje závislost úpravy obsahu na konkrétním nástroji. Vytvoříte online dokumentaci kompatibilní s DITA (sadu souborů XML) a její budoucí editace a údržba bude možná prostřednictvím jakéhokoli jiného nástroje kompatibilního s DITA!
Protože specifikace DITA je oblast, která vyžaduje zvláštní pozornost, nechám si ji na jiný článek.
Tip autora: Stačí říci, že sada nástrojů oXygen je životaschopnou alternativou k nesmírně populárnímu, ale neúměrně drahému Adobe Framemaker. oXygen Author se obvykle používá v kombinaci s oXygen Developer.
Takže to je všechen software pro technické psaní, který budete potřebovat ve fázi „Informace o dokumentu“. Příští a poslední část bude obsahovat fázi „Publikování informací“.
Chcete-li se dozvědět několik skvělých tipů pro technické psaní a mít jistotu, že vám neuniknou naše aktualizace nástrojů pro technické psaní, přihlaste se k odběru našeho blogu.
Líbí se vám to? Přidejte si článek do záložek nebo ho sdílejte se svými přáteli a kolegy!

Ve společnosti Whatfix inovujeme oblast nástrojů pro technické psaní tím, že narušujeme samotnou myšlenku dlouhého souvislého psaného obsahu. Naši interaktivní průvodci vám pomohou zvýšit produktivitu tím, že vám poskytnou rychlý a efektivní způsob tvorby technické dokumentace. Přečtěte si více o tom, jak Whatfix pomáhá při psaní technických textů, v tomto článku.