Er du en kommende teknisk forfatter, der blot ønsker at komme i gang, men som ikke ved, hvilke værktøjer du skal bruge til at dokumentere dine tekster? Nå, men du er kommet til det rette sted!
Først og fremmest skal vi forstå, hvad teknisk dokumentation præcis er
Man har brug for at dokumentere sin proces, og derfor betragtes et teknisk dokument som en af de vigtige faktorer, der bidrager til et softwareprojekts succes.
Et teknisk dokument bør ikke kræve en ph.d. for at forstå, med enklere ord og med hensyn til teknik henviser teknisk dokumentation til enhver form for dokumentation, der beskriver håndtering, funktionalitet og arkitektur af et teknisk produkt eller ethvert andet produkt, der er under udvikling eller i brug.
Dokumentation kan spænde fra et kravsseddel på én side til en tyk referencehåndbog, der dokumenterer et nyt open source framework.
I dag er dokumentation for apps, API’er, SDK’er og selv de fleste hardwareprodukter tilgængelige online.
Jeg har listet de bedste værktøjer til teknisk dokumentation sammen med links for at få en fornemmelse af dem og forstå dem bedre, så lad os komme i gang, skal vi?
HelpNDoc er et brugervenligt, men kraftfuldt forfatterværktøj, som er alsidigt til dine forskellige behov, det kan generere forskellige dokumentationsformater fra en enkelt kilde.
HelpNDoc giver alle de nødvendige værktøjer til at skrive komplette hjælpefiler, manualer og dokumentation i et brugervenligt og meget let anvendeligt miljø.
Det kan generere standard Windows CHM-hjælpefiler, WEB-baseret dokumentation, iPhone-specifikke websteder samt printbare PDF- og Word-dokumenter.
Funktioner
– HelpNDoc giver forfatteren mulighed for at oprette en enkelt kildetekst, som det derefter konverterer til en række målformater såsom HTML-hjælp, PDF, RTF, DocX, Qt Help og HTML-dokumentation samt EPUB og Amazon Kindle-kompatible e-bøger.
– Den har også mulighed for at generere kode til programmeringssprogene C++, Delphi, Fortran, Pascal og Visual Basic med henblik på integration af de genererede CHM-hjælpefiler med den applikation, der er under udvikling.
– Fra og med version 4 leveres HelpNDoc med en projektanalysator, der kan spore dokumentets layout, give statistik og identificere potentielle problemer såsom brudte links eller problemer med medieelementer.
- HelpNDoc kan også bruges til at udgive mobile websteder, hvor indholdsfortegnelsen bruges som navigationsmenu, indholdet af emnerne med navigationsknapper, søgeordsindeksmenuen, en indbygget søgemaskine og mobilspecifikke brugergrænsefladeelementer.
https://www.helpndoc.com/
#2 ClickHelp
Har du brug for et dokumentationsværktøj med en lang række funktioner, så er ClickHelp det rette for dig. ClickHelp er et moderne browserbaseret dokumentationsværktøj, som er let at opsætte og bruge, det kræver ingen installation, kører i en webbrowser og understøtter flere platforme: Mac OS, Windows og Linux, hvilket gør det nemt at skrive din dokumentation fra et hvilket som helst sted i verden.
Softwarevirksomheder over hele verden bruger ClickHelp til at oprette online brugermanualer, vidensbaser, hjælpefiler, FAQ’er, tutorials og offentliggøre dem øjeblikkeligt i deres portal.
Funktioner
-Daglig backup- ClickHelp leverer daglige backups, så du kan sikre dig, at dine data er sikre
-Advanced Analytics- ClickHelp har sin egen integrerede analyse, som hjælper dig med at analysere den aktuelle situation og hjælper dig også med at planlægge din dokumentationsproces fremadrettet.
-Human Readable Project URL’er- En funktion, der ikke kun er nyttig for mennesker, men også for søgemaskiner, denne funktion hjælper med SEO af din dokumentation
-Social Media Sharing Buttons- Del nemt din dokumentation på tværs af forskellige sociale medier.
-Review Notes for topics- Gennemgang er den fase i dokumentationsskrivningsprocessen, som ikke et team kan springe over. ClickHelp tilbyder ikke kun funktionaliteten for gennemsynsnoter, men også en særlig Reviewer Role.
-Kraftig Editor til emner- Enhver teknisk skribent kan lide en god teksteditor, ClickHelp tilbyder Word-lignende funktionalitet og mere for at give dig et behageligt arbejdsmiljø.
- Integrationer- ClickHelp har imponerende muligheder for integrationer såsom : Zendesk, AddThis, Disqus, Google Analytics, Google Search Console, Azure AD SSO, Google SSO, Salesforce SSO, YouTube, Vimeo, Gravatar, Screencast.com, osv.
https://clickhelp.com/
#3 Whatfix
Ønsker du at oprette en interaktiv vejledning på din platform? Whatfix er det rette værktøj for dig.
Whatfix er en digital adoptionsplatform, der hjælper virksomheder med at optage, uddanne og støtte deres applikationsbrugere.
Whatfix giver dig mulighed for at oprette og levere kontekstuelt og tilpasset indhold i form af flows, hjælpetips, videoer, links og tekst, alt sammen som en in-app-oplevelse
Whatfix kan bruges til at oprette indhold på enhver webbaseret virksomhedsapplikation som Salesforce, SAP SuccessFactors, Oracle HCM Cloud osv. tilpassede webapplikationer og på forbrugervendte websteder.
Dertil kommer, at Whatfix understøtter både cloud- og selvhostede implementeringsformer.
Funktioner
-Multi-browser-kompatibilitet API
-Interaktive brugervejledninger
-Selvhosting
-Dataanalyse
-User Tracking
-Multiple guide-formater, herunder videoer, grafik, billeder og tekster.
– Tilpasbar brugergrænseflade
#4 ProcessStreet
ProcessStreet er den enkleste måde at administrere tilbagevendende arbejdsgange for dit team på. Desuden hjælper det med hurtigt at tildele tjeklistearbejdsgange til dit team.
ProcessStreet har en enkel grænseflade, som hjælper dig med at oprette et struktureret dokument på få sekunder. Desuden kan du spore aktivitet fra dashboardet, og den giver besked, når opgaverne er udført.
Det er hjemsted for dit teams procesdokumenter, deres intuitive tastaturgenveje og træk og slip gør det nemt for alle at bruge.
Funktioner
-Betinget logik- Brug betinget logik til at oprette virkelig dynamiske tjeklister med hvis/så logik, der tilpasser sig dine teams skiftende behov.
-Brug formularer til at indsamle strukturerede data- Brug formularer til at indsamle strukturerede data i dine tjeklister. Indtast data manuelt, eller få dem sendt til og fra de apps, du vælger.
-Regler baseret arbejdsgang
-Samarbejdsområde
Sammenfattende
Der findes forskellige softwareværktøjer til forskellige typer teknisk dokumentation, og det afhænger af din målgruppe, hvilket du vælger. Du skal få en fornemmelse af det, der tiltrækker dig mest, og bare gå efter det, når du først er kommet i gang, kan du altid beslutte, hvilket der er ideelt for dig!