Är du en blivande teknisk skribent som bara vill komma igång men inte vet vilka verktyg du ska använda för att dokumentera dina texter? Då har du kommit till rätt ställe!
Först och främst ska vi förstå vad exakt teknisk dokumentation är
Man måste dokumentera sin process och därför anses ett tekniskt dokument vara en av de viktiga faktorerna som bidrar till att ett mjukvaruprojekt blir framgångsrikt.
Ett tekniskt dokument bör inte kräva en doktorsexamen för att förstå, med enklare ord och i tekniska termer hänvisar teknisk dokumentation till alla typer av dokumentation som beskriver hantering, funktionalitet och arkitektur hos en teknisk produkt eller någon annan produkt som är under utveckling eller i användning.
Dokumentation kan sträcka sig från ett kravblad på en sida till en tjock referensmanual som dokumenterar ett nytt ramverk med öppen källkod.
I dag finns dokumentation för appar, API:er, SDK:er och till och med de flesta hårdvaruprodukter tillgängliga på nätet.
Jag har listat de bästa verktygen för teknisk dokumentation tillsammans med länkar för att du ska kunna få en känsla för dem och förstå dem bättre, så låt oss komma igång, ska vi?
HelpNDoc är ett lättanvänt men kraftfullt författarverktyg som är mångsidigt för dina olika behov, det kan generera olika dokumentationsformat från en enda källa.
HelpNDoc ger alla verktyg som behövs för att skriva kompletta hjälpfiler, handböcker och dokumentation i en användarvänlig och mycket lättanvänd miljö.
Det kan generera standard Windows CHM hjälpfiler, WEB-baserad dokumentation, iPhone-specifika webbplatser samt utskrivbara PDF- och Word-dokument.
Funktioner
– HelpNDoc gör det möjligt för skribenten att skapa en enda källtext som sedan konverteras till ett antal målformat, t.ex. HTML-hjälp, PDF, RTF, DocX, Qt Help, och HTML-dokumentation samt EPUB och Amazon Kindle-kompatibla e-böcker.
– Det har också möjlighet att generera kod för programmeringsspråken C++, Delphi, Fortran, Pascal och Visual Basic för integrering av de genererade CHM-hjälpsfilerna med den applikation som utvecklas.
– Från och med version 4 har HelpNDoc en projektanalysator som kan spåra dokumentets layout, tillhandahålla statistik och identifiera potentiella problem som trasiga länkar eller problem med medieobjekt.
- HelpNDoc kan också användas för att publicera mobila webbplatser, med hjälp av innehållsförteckningen som navigeringsmeny, ämnesinnehållet med navigeringsknappar, menyn för nyckelordsindex, en inbyggd sökmotor och mobilspecifika användargränssnittselement.
https://www.helpndoc.com/
#2 ClickHelp
Bedömer du ett dokumentationsverktyg med en mängd olika funktioner så är ClickHelp något för dig. ClickHelp är ett modernt webbläsarbaserat dokumentationsverktyg som är enkelt att installera och använda, det kräver ingen installation, körs i en webbläsare och har stöd för flera plattformar: Mac OS, Windows och Linux, vilket gör det enkelt att skriva din dokumentation från vilken plats som helst i världen.
Mjukvaruföretag över hela världen använder ClickHelp för att skapa användarhandböcker, kunskapsdatabaser, hjälpfiler, vanliga frågor och svar, handledningar online och publicera dem direkt i sin portal.
Funktioner
-Daglig säkerhetskopiering- ClickHelp tillhandahåller daglig säkerhetskopiering så att du kan försäkra dig om att dina data är säkra
-Advanced Analytics- ClickHelp har en egen integrerad analys som hjälper dig att analysera den aktuella situationen och hjälper dig också att planera din dokumentationsprocess framåt.
-Human Readable Project URLs- En funktion som är användbar inte bara för människor utan även för sökmotorer, den här funktionen hjälper till med SEO för din dokumentation
-Knappar för delning på sociala medier- Dela enkelt din dokumentation på olika sociala medier.
-Granskningsanteckningar för ämnen- Granskning är det skede i dokumentationsskrivningsprocessen som inte ett team kan hoppa över. ClickHelp erbjuder inte bara funktionalitet för granskningsanteckningar, utan även en speciell roll för granskare.
-Kraftig ämnesredigerare- Varje teknisk skribent gillar en bra textredigerare, ClickHelp erbjuder Word-liknande funktionalitet och mer för att ge dig en bekväm arbetsmiljö.
- Integreringar- ClickHelp har imponerande alternativ för integrationer som : Zendesk, AddThis, Disqus, Google Analytics, Google Search Console, Azure AD SSO, Google SSO, Salesforce SSO, YouTube, Vimeo, Gravatar, Screencast.com, etc.
https://clickhelp.com/
#3 Whatfix
Vill du skapa en interaktiv guide på din plattform? Whatfix är det rätta verktyget för dig.
Whatfix är en plattform för digital adoption som hjälper företag att ta in, utbilda och stödja sina applikationsanvändare.
Whatfix låter dig skapa och leverera kontextuellt och anpassat innehåll i form av flöden, hjälptips, videor, länkar och text, allt som en upplevelse i appen
Whatfix kan användas för att skapa innehåll på alla webbaserade företagsapplikationer som Salesforce, SAP SuccessFactors, Oracle HCM Cloud, etc. anpassade webbapplikationer och på webbplatser som vänder sig till konsumenter.
Det finns dessutom stöd för Whatfix för både moln- och självhyst driftsätt.
Funktioner
-API för kompatibilitet med flera webbläsare
-Interaktiva användarhandledningar
-Självhystning
-Dataanalys
-Utomatisering av användarna
-Mångfaldiga format för handledningar, inklusive videoklipp, grafik, bilder och texter.
-Anpassningsbart användargränssnitt
#4 ProcessStreet
ProcessStreet är det enklaste sättet att hantera återkommande arbetsflöden för ditt team. Dessutom hjälper det dig att snabbt tilldela arbetsflöden med checklistor till ditt team.
ProcessStreet har ett enkelt gränssnitt som hjälper dig att skapa ett strukturerat dokument på några sekunder. Dessutom kan du spåra aktivitet från instrumentpanelen och den meddelar när uppgifter är gjorda.
Det är hemmet för ditt teams processdokument, deras intuitiva tangentbordsgenvägar och drag-och-släpp gör det enkelt för vem som helst att använda.
Funktioner
-Conditionell logik- Använd villkorlig logik för att skapa verkligt dynamiska checklistor med om/då-logik som anpassar sig till teamets föränderliga behov.
-Använd formulär för att samla in strukturerade data- Använd formulär för att samla in strukturerade data i dina checklistor. Ange data manuellt eller låt dem skickas till och från de appar du väljer.
-Regelbaserat arbetsflöde
-Collaborative Workspace
Slutsatsen
Det finns olika programvaruverktyg tillgängliga för olika typer av teknisk dokumentation, vilket du väljer beror på din målgrupp. Du måste få en känsla för det som lockar dig mest och bara satsa på det, när du väl har börjat kan du alltid bestämma dig för vilket som är idealiskt för dig!