Ben jij een ambitieuze technisch schrijver die net wil beginnen, maar die niet weet welke hulpmiddelen hij moet gebruiken om zijn werk te documenteren? Dan bent u bij ons aan het juiste adres!
Laten we eerst en vooral begrijpen wat technische documentatie precies is
Een mens moet zijn proces documenteren en daarom wordt een technisch document beschouwd als een van de belangrijke factoren die bijdragen aan het succes van een softwareproject.
Een technisch document zou geen doctoraat moeten vereisen om te begrijpen, in eenvoudiger woorden en in termen van engineering, verwijst technische documentatie naar elk type documentatie dat de behandeling, functionaliteit en architectuur beschrijft van een technisch product of een ander product dat in ontwikkeling of in gebruik is.
Documentatie kan variëren van een requirements sheet van één pagina tot een dikke referentiehandleiding die een nieuw open-source framework documenteert.
Tegenwoordig is documentatie voor apps, API’s, SDK’s en zelfs de meeste hardwareproducten online beschikbaar.
Ik heb de beste tools voor Technische Documentatie op een rij gezet, samen met links om een gevoel van ze te krijgen en ze beter te begrijpen, dus laten we aan de slag gaan, zullen we?
HelpNDoc is een eenvoudig te gebruiken maar krachtige authoring tool die veelzijdig is voor uw verschillende behoeften, het kan verschillende documentatieformaten genereren vanuit een enkele bron.
HelpNDoc biedt alle hulpmiddelen die nodig zijn om complete helpbestanden, handleidingen en documentatie te schrijven in een gebruikersvriendelijke en een zeer eenvoudig te gebruiken omgeving.
Het kan genereren standaard Windows CHM help-bestanden, WEB gebaseerde documentatie, iPhone-specifieke websites, alsmede afdrukbare PDF-en Word-documenten.
Features
– HelpNDoc stelt de schrijver in staat om een enkele bron tekst die het vervolgens converteert naar een aantal doelformaten, zoals HTML Help, PDF, RTF, DocX, Qt Help, en HTML-documentatie evenals EPUB en Amazon Kindle compatibele E-books te creëren.
– Het heeft ook de mogelijkheid om code te genereren voor de C++, Delphi, Fortran, Pascal en Visual Basic programmeertalen voor de integratie van de gegenereerde CHM Help-bestanden met de applicatie die wordt ontwikkeld.
– Vanaf versie 4 wordt HelpNDoc geleverd met een projectanalysator die de lay-out van het document kan bijhouden, statistieken kan leveren en potentiële problemen kan identificeren, zoals gebroken links of problemen met media-items.
- HelpNDoc kan ook worden gebruikt om mobiele websites te publiceren, waarbij gebruik wordt gemaakt van de inhoudsopgave als navigatiemenu, de inhoud van de onderwerpen met navigatieknoppen, het trefwoordenregister-menu, een ingebouwde zoekmachine en mobiele-specifieke gebruikersinterface-elementen.
https://www.helpndoc.com/
#2 ClickHelp
Heeft u een documentatiehulpmiddel nodig met een verscheidenheid aan functies, dan is ClickHelp het hulpmiddel voor u. ClickHelp is een moderne browser-gebaseerde documentatie tool die gemakkelijk is op te zetten en te gebruiken, het vereist geen installatie, draait in een web browser en ondersteunt meerdere platformen: Mac OS, Windows en Linux, waardoor het gemakkelijk is om uw documentatie te schrijven vanaf elke plaats in de wereld.
Softwarebedrijven over de hele wereld gebruiken ClickHelp om online gebruikershandleidingen, kennisbanken, helpbestanden, FAQ’s, tutorials te maken en direct te publiceren in hun portal.
Features
-Dagelijkse back-ups- ClickHelp biedt dagelijkse back-ups, zodat u zeker weet dat uw gegevens veilig zijn
-Advanced Analytics- ClickHelp heeft zijn eigen geïntegreerde analytics die u helpt bij het analyseren van de huidige situatie en helpt bij het plannen van uw documentatieproces vooruit ook.
-Human Readable Project URL’s- Een functie die niet alleen nuttig is voor mensen maar ook voor zoekmachines, deze functie helpt bij de SEO van uw documentatie
-Social Media Sharing Buttons- Deel eenvoudig uw documentatie via verschillende sociale media.
-Review Notes for topics- Reviewing is de fase in het documentatie schrijfproces die geen team kan overslaan. ClickHelp biedt niet alleen de functionaliteit voor review notes, maar ook een speciale Reviewer Role.
-Powerful Topic Editor- Elke technisch schrijver houdt van een goede teksteditor, ClickHelp biedt Word-achtige functionaliteit en meer om u een comfortabele werkomgeving te bieden.
- Integrations- ClickHelp heeft indrukwekkende opties voor integraties zoals : Zendesk, AddThis, Disqus, Google Analytics, Google Search Console, Azure AD SSO, Google SSO, Salesforce SSO, YouTube, Vimeo, Gravatar, Screencast.com, enz.
https://clickhelp.com/
#3 Whatfix
Wilt u een interactieve gids maken op uw platform? Whatfix is de juiste tool voor u.
Whatfix is een Digital Adoption Platform dat ondernemingen helpt bij het onboarden, trainen en ondersteunen van hun applicatiegebruikers.
Whatfix stelt u in staat om contextuele en op maat gemaakte content te creëren en te leveren in de vorm van flows, helptips, video’s, links en tekst, allemaal als een in-app ervaring
Whatfix kan worden gebruikt om content te creëren op elke web-gebaseerde enterprise applicatie zoals Salesforce, SAP SuccessFactors, Oracle HCM Cloud, etc. aangepaste webapplicaties en op consumentgerichte websites.
Daarnaast ondersteunt Whatfix zowel de cloud als self-hosted modi of deployment.
Features
-Multi-browser compatibiliteit API
-Interactieve gebruikersgidsen
-Self-Hosting
-Data Analytics
-User Tracking
-Multi-gids formaten, waaronder video’s, afbeeldingen en teksten.
-Aanpasbare gebruikersinterface
#4 ProcessStreet
ProcessStreet is de eenvoudigste manier om terugkerende workflows voor uw team te beheren. Bovendien helpt het u snel checklistworkflows aan uw team toe te wijzen.
ProcessStreet heeft een eenvoudige interface waarmee u in enkele seconden een gestructureerd document kunt maken. Bovendien kunt u de activiteit bijhouden vanuit het dashboard en het geeft een melding wanneer taken zijn voltooid.
Het is het huis voor de procesdocumenten van uw team, hun intuïtieve sneltoetsen en slepen en neerzetten maakt het gemakkelijk voor iedereen om te gebruiken.
Features
-Conditional Logic- Gebruik conditionele logica om echt dynamische checklists te maken met if/then logica die zich aanpast aan de veranderende behoeften van uw teams.
-Gebruik formulieren om gestructureerde gegevens vast te leggen- Gebruik formulieren om gestructureerde gegevens in uw checklists te verzamelen. Voer gegevens handmatig in of laat ze verzenden van en naar de apps die u kiest.
-Rules based Workflow
-Collaborative Workspace
In conclusie
Er zijn verschillende softwaretools beschikbaar voor verschillende soorten Technische Documentatie; welke u kiest, hangt af van uw doelgroep. Je moet een gevoel krijgen van degene die je het meest aantrekt en er gewoon voor gaan, als je eenmaal begonnen bent kun je altijd nog beslissen welke voor jou ideaal is!