Free Press

För att fortsätta där vi slutade i del 1 av serien om programvaruverktyg för teknisk skrivning. (Kolla in den om du inte har läst den)
I den här delen behandlar vi de tekniska skrivverktyg som används i fasen ”Dokumentera information”.
Detta är skrivandet, redigeringen, ritningen, granskningen och omskrivningen. Det är den fas då informationsdokumentationsteamet är på sin fulla styrka och spottar ut guider, handböcker, bloggar, videodemonstrationer, hjälpsidor på nätet och vad vet jag. Med tanke på de varierande uppgifterna i denna fas är de tekniska skrivverktyg som används också mycket varierande och otaliga.

Top 17 Technical Writing Software Tools For Documentation in 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. Whatfix

Whatfix innebär ett paradigmskifte i hur hjälpdokumentation presenteras online. Statiska och långa webbhjälpssidor fångar inte användarens uppmärksamhet lika effektivt som de interaktiva, bildbaserade guider som presenteras av Whatfix, populärt kallade ”ballonger”.
I dagens värld måste dessutom onlinehjälpen spridas över olika prylar – oavsett om det är datorer, surfplattor eller smarttelefoner. Whatfix anpassar automatiskt innehållet i hjälpen för att passa gadgeten. Och samma hjälpinnehåll kan nås i olika former – som ett bildspel, en PDF eller en video.
Författarens tips: Whatfix har stöd för en unik funktion – Interaktiv genomgång i realtid – där du lägger in dina hjälpsnuttar direkt på den levande produktsidan! Användaren läser utdraget i Whatfix-ballongen och utför åtgärden i enlighet med detta på sidan. Detta är ett populärt verktyg för teknisk skrivning bland företag som vill byta från de traditionella metoderna.

MediaWiki

Att visa din produkts onlinehjälp som wikisidor är en enkel och effektiv idé. Dina sidor kan integreras direkt i Wikipedia om du inte har en separat webbplats för din onlineprodukt. Alternativt kan du vara värd för Wiki-liknande hjälpsidor på din produktwebbplats. Att detta format är mycket välkänt bland online-användare är en viktig fördel, och det kostnadsfria wiki-redigeringsverktyget MediaWiki Visual Editor gör det ganska enkelt att skapa hjälp.
MediaWiki är ett PHP-baserat webbredigeringsverktyg som Wikipedia använder. Men även stora programvaruföretag, där Intel är ett viktigt exempel, använder detta verktyg för att presentera sin försäljnings- och marknadsföringsinformation, How To’s och hjälpsidor om policy och förfaranden.
Författarens tips: Detta verktyg för tekniskt skrivande har bra stöd för tillägg – för flerspråkigt innehåll, gemensam granskning, spårning av redigeringar, inbyggd sökning etc.

Adobe RoboHelp

Branschens standardverktyg för författare som används för att skapa hjälpsystem för skrivbords- eller webbaserade tillämpningar. Ingen datoranvändare är främmande för RoboHelp! Varje gång du trycker på F1 i något av dina standardprogram är det hjälpfönster som visas nästan alltid skapat med RoboHelp. Det kan dock också användas för att skapa konventionell teknisk dokumentation för tryckning, t.ex. guider och handböcker.
Den sofistikerade RoboHelp IDE gör det möjligt för tekniska skribenter att utveckla storskaliga hjälpprojekt och återge dem på flera olika hårdvaruenheter/operativsystem och i flera olika format (PDF, HTML, DOC, etc.). Den äldre versionen av RoboHelp kan köpas som en lågkostnadsutgåva om budgeten är begränsad. Små företag kan dock hålla sig till enkla, kostnadsfria alternativ som WordPress-bloggar eller Wikis. Gamla MS Word kan också generera grundläggande HTML-hjälpfiler åt dig.
Författarens tips: Det kan vara en stor utmaning för tekniska skribenter att hantera stora programvaruprodukter med regelbundna uppgraderingsversioner, eftersom de måste vara synkroniserade med produktens ändringshistorik. Hjälpfiler visar ofta konfigurerbara användardefinierade variabler som upprepas flera gånger i hjälpdokumentationen. (Till exempel är en variabel som ”Sleep time after inactivity” (vilotid efter inaktivitet) inställd på 30 sekunder i den tidigare versionen, som ska ställas in på 1 minut i uppgraderingen). RoboHelp-projektet skulle ta hand om uppdateringen av variabelvärdet i alla hjälpfiler!

Notepad++

En mycket effektiv HTML-redigerare för nybörjare. De flesta lär sig grunderna i HTML-programmering med detta verktyg för tekniskt skrivande. Om din mjukvaruprodukt inte kräver mycket omfattande hjälpdokumentation online är det här verktyget mer än tillräckligt för att göra hjälpfiler av medelstorlek.
Det anpassningsbara grafiska användargränssnittet gör det enkelt att redigera, det stöder WYSIWYG för utskrift och har även stöd för flera språk.
Författarens tips: Notepad++ levereras med en rik uppsättning plug-ins. Multi-clipboard, Code Compare, Auto-Save är några populära sådana. Tekniska skribenter måste välja rätt uppsättning insticksprogram, som kan förvandla en vanlig nybörjarredigerare till ett gångbart alternativ för redigering av onlinehjälp.

WordPress

Den bästa platsen om du vill ha teknisk dokumentation för din produkt i form av bloggar. WordPress är en gratis plattform för innehållshantering online med öppen källkod. Bloggar som skrivs på WordPress kan antingen nås direkt från WordPress-bloggens URL eller integreras i företagets webbplats.
Den här artikeln i sig finns på WordPress-bloggen Whatfix Academy. Om målet är att regelbundet publicera online-innehåll om ditt företag/tillhörande teknik, ska du skapa ett WordPress-bloggkonto. Bloggar kan också fånga upp användarsvar i form av kommentarer och likes, vilket gör det lättare att engagera sig med din målgrupp och känna deras uppskattning för din produkt.
Författarens tips: Bloggar i isolering kanske inte samlar tillräckligt många ögonblick. Så skriv din blogg först, marknadsför den sedan på sociala medieplattformar och mät slutligen tittarsiffrorna och svaren innan du fortsätter med nästa uppsättning bloggar!
Övrigt att läsa: Hur teknisk skrivning förändras med tiden

Adobe Photoshop

Ett verktyg som de flesta tekniska skribenter i hela branschen svär på. Det är världens mest populära bildredigeringsverktyg för att skapa och redigera foton och raster (pixel)-baserade konstverk. Kan användas för att skapa användargränssnittsdesign, webbsidor, bannerannonser, videografik, redigering av bilder för tryck. Manipulering av en bild, överlagring av en bild på en annan, förfining av ett fotografi för att utjämna ojämnheter, korrigering av belysningsproblem är dess mest populära användningsområden. Bildredigeringsprocessen är reversibel och inkrementell så att ändringarna lätt kan återställas.
Författarens tips: För professionella formgivare, som ständigt är i behov av ett bildredigeringsverktyg, finns det nästan ingen ersättning för Adobe Photoshop. Om du däremot är en tillfällig användare kan du prova GIMP som är en öppen källkod. Det stöder endast RGB-färgscheman medan Photoshop också stöder CMYK-färgscheman (CYAN YELLOW MAGENTA BLACK). Inlärningskurvan är högre för GIMP, men det är gratis medan Photoshop kostar en bomb!

Adobe Illustrator

Verktyg för att skapa och redigera vektorbaserade illustrationer, t.ex. logotyper och varumärken eller andra designelement. Grafiska formgivare gör ofta misstaget att utforma sina produktlogotyper i Photoshop. Men samma logotyp måste tryckas på visitkort och på massiva reklamtavlor. Så bildskalning utan att förlora tydligheten är nyckeln här, vilket vektorgrafikbaserade bildbehandlingsverktyg åstadkommer. Adobe Illustrator och Corel Draw är de ledande verktygen för teknisk skrivning teknisk skrivning i detta område.
Författarens tips: Det här verktyget är en del av Adobe Creative Cloud-lösningen med dyra månadshyror. Alternativa kostnadsfria tekniska skrivverktyg som Inkscape eller Affinity Designer kan göra jobbet lika bra med SVG-format. Om du inte behöver alla större verktyg för teknisk skrivning som ingår i den här lösningen (Photoshop, InDesign etc.) är det här verktyget inte ett måste.

Microsoft Visio

Ett populärt diagramverktyg som används vid utformning av tekniska tillämpningar. Tekniska skribenter behöver ofta utforma flödesscheman, arkitektoniska diagram, elektriska kretsdiagram, utformning av mjukvaruprodukter och så vidare. Visio är ett bekvämt hjälpmedel för detta.
Det är ett IEEE-kompatibelt tekniskt skrivverktyg som överensstämmer med standarder för programvaruindustrin som UML (Unified Modeling Language) och BPMN (Business Process Model and Notation).
Författarnas tips: Visio har inte varit en del av den traditionella Microsoft Office-paketet, utan har alltid sålts separat i likhet med MS Project. Men ett alldeles nyligen offentliggjort meddelande från Microsoft säger att onlineprenumeranter av Office 365 nu kan få tillgång till Visio också.

Windows Snipping Tool

Om du letar efter skärmklippningsalternativ som är mer sofistikerade än PrntScr på ditt tangentbord, är Snipping Tool ett bra val. Förutom att fånga hela skärmen kan du också fånga frihandsutklipp eller utklipp av delar av skärmen. Om du vill fånga stillbilder från videor använder du fördröjningsalternativet så att den exakta bilden kan sparas som en bild.
Författartips: Programmet ingår i Windows programvarusvit, men är kanske inte aktiverat som standard i vissa utgåvor av Windows.

Windows Movie Maker

Ett enkelt videoredigeringsverktyg som tekniska skribenter kan använda för att göra sina videor för produktdemonstrationer. Det ingår i sviten Windows Essentials. Sedan januari 2017 har den här programvaran dock upphört att användas, utan att en ordentlig ersättare har tillkännagivits. Så alla användare med äldre Windows-versioner kan tacka sina lyckliga stjärnor!
Författarnas tips: Du kan ordna och redigera video- och ljudklipp i en storyboard-vy, bild för bild. Eller en serie stillbilder kan sträcka sig på en tidslinje. Ljudröstning i kombination med bakgrundsljud kan ge dina videor en sofistikerad prägel.

Powtoon

Teknisk skrift blir alltmer visuell. Animerade videor är ett utmärkt sätt att fånga användarnas uppmärksamhet och förmedla budskapet på ett engagerande sätt. Powtoon är ett bra webbaserat animationsverktyg som säljs som en SaaS-produkt. Animerade presentationer och förklaringsvideor kan skapas gratis med detta verktyg. De videor som skapas med gratisversionen har dock ett vattenmärke från Powtoon.
Författarnas tips: Om den tekniska texten inte är avsedd för officiella ändamål är det helt okej att använda gratisversionen av det här verktyget. Men för en nominell hyra kan du få premiumversionen som gör att du kan skapa videor utan vattenstämpel och flera andra funktioner.

Prezi

En okonventionell metod för att göra demos i form av en videopresentation. Till skillnad från Powerpoint, där innehållet är strikt uppdelat i diabilder, ger Prezi dig bara en stor tom duk. Du kan skriva och rita på den som du vill. Genom att zooma in eller ut från innehållet i fokus och flytta fokus från en ram till en annan på samma canvas kan du göra en kontinuerlig videopresentation.
Författarnas tips: Förutom gratisversionen finns det en testversion för studenter som också är gratis och som har nästan alla funktioner som den betalda versionen. Välj den.
Läs också – 14 missuppfattningar om teknisk skrivning som du bör känna till!

Microsoft Word

Det känns ganska dumt att skriva om det allestädes närvarande MS Word. Men hur vanligt det än är i vår digitala vardag är det fortfarande en teknisk skribents bästa vän! Med enkel konvertering mellan PDF- och DOC-format är den enkla kombinationen av Word och Adobe Acrobat Reader inte att ta lätt på. Den här artikeln kanske handlar om alla fina tekniska skrivverktyg i världen, men den är skriven med hjälp av – det enkla MS Word!
Författartips: Experimentera med de olika dokumentmallar som Word har att erbjuda. De hjälper till att få ditt dokument att se lämpligt ut för det avsedda ändamålet – som marknadsföringsfoldrar, tekniska whitepapers, felsökningsguider och så vidare.

Kingsoft WPS Office

MS Word, PowerPoint och Excel är kända för att vara de mest använda programvaruverktygen för teknisk skrivning, milsvid före de alternativ som finns tillgängliga. Endast Android-revolutionen har bromsat MS Office-juggernauten en aning. Och gett en framträdande position till Kingsoft Office, ett rimligt och gratis alternativ till MS Office.
Författarnas tips: Det finns några nyanserade funktioner som WPS Writer inte stöder – tesaurus är en av dem. Thesaurus är en viktig funktion för tekniska skribenter eftersom vi ständigt letar efter bättre ord för att uttrycka samma punkter i olika tekniska dokument!

Google Docs

I en värld som i allt högre grad vänder sig till en behändig mobiltelefon för att läsa dokument, i stället för att ta sig besväret att sätta igång datorn, vinner google docs i långsamt framträdande ställning. Att skapa dokument från grunden skulle inte vara bekvämt på Google Docs, men gemensam granskning och redigering kan göras effektivt genom detta molnbaserade alternativ till MS Office.
Författarens tips: Dess sömlösa integrering med Gmail och Google Drive gör det ännu mer attraktivt. Som teknisk skribent skulle du hålla dig till de sofistikerade ordbehandlingsverktygen. Men din produktchef som kanske är på resande fot hela tiden kommer med största sannolikhet att hinna med sina recensioner på sin telefon!

Adobe Framemaker

En sofistikerad dokumentbehandlare för stora, industriella standarddokument. Kan användas för att generera strukturerade dokument med ett XML-ramverk, med 100 % DITA-överensstämmelse. Kan även användas för ostrukturerade dokument, som ersättning för dokumentredigerare som MS Word.
Framemaker är ett bra val för att generera strukturerade dokument med fördefinierade mallar som överensstämmer med flera industriella standardformat – till exempel juridiska avtal och bokslut. Det stöder skapande av TOC eller index över flera dokument, har rika formateringsalternativ. Sjunker inte i prestanda när grafik infogas.
Författarens tips: Framemaker är en bra investering för etablerade företag med formella tekniska skrivarteam som behöver producera stora dokument på över 100 sidor. Företag som tillverkar en enda produkt och nystartade företag behöver dock inte göra denna investering. Det finns gratis verktyg XML-baserade verktyg för författande av dokument som är gratis. Och du kan alltid falla tillbaka på gamla goda MS Word!

oXygen XML Author

Det här är en gratis DITA-kompatibel XML-redigerare med öppen källkod, med många lojala användare och goda recensioner. DITA (Document Information Typing Architecture) är en öppen standard för författande och publicering av dokument som långsamt har tagit sig in i teknisk dokumenthantering. Helt enkelt för att den tar bort beroendet av att redigera innehåll på ett visst verktyg. Om du producerar DITA-kompatibel onlinedokumentation (en uppsättning XML-filer) kan du redigera och underhålla den i framtiden med vilket annat DITA-kompatibelt verktyg som helst!
Då DITA-specifikationer är ett område som kräver särskilt fokus, låt mig spara det till en annan artikel.
Författarens tips: Det räcker med att säga att oXygen-sviten av verktyg är ett bra alternativ till det enormt populära men oöverkomligt dyra Adobe Framemaker. oXygen Author används vanligen i kombination med oXygen Developer.
Så, det är alla programvaror för teknisk skrivning som du kommer att behöva i fasen ”dokumentinformation”. Nästa och sista del kommer att innehålla fasen ”Publicera informationen”.
För att lära dig några bra tips för teknisk skrivning och för att se till att du inte missar våra uppdateringar om verktyg för teknisk skrivning kan du prenumerera på vår blogg.
Gillar du det? Lägg artikeln som bokmärke eller dela den med dina vänner och kollegor!

Vi på Whatfix förnyar området för tekniska skrivverktyg genom att bryta upp själva idén om långvarigt, kontinuerligt skrivet innehåll. Våra interaktiva guider hjälper dig att bli mer produktiv genom att ge dig ett snabbt och effektivt sätt att skapa teknisk dokumentation. Läs mer om hur Whatfix hjälper till med tekniskt skrivande i den här artikeln.