Het schrijven van softwaredocumentatie speelt een integrale rol in het werk van een programmeur. Zoals ze zeggen, als het niet gedocumenteerd is, bestaat het niet, en in de meeste gevallen is het op de juiste manier documenteren van je code net zo belangrijk als het daadwerkelijk schrijven ervan. 'Hoe geweldig je bibliotheek ook is en hoe intelligent het ontwerp ook is, als jij de enige bent die hem begrijpt, heb je er niets aan. Documentatie betekent niet alleen automatisch gegenereerde API-referenties, maar ook geannoteerde voorbeelden en diepgaande tutorials. Je hebt ze alle drie nodig om ervoor te zorgen dat je bibliotheek gemakkelijk kan worden overgenomen”, zegt Nicholas Zakas, een bekende front-end engineer en auteur van boeken. Daarom hebben we vandaag besloten om enkele van de beste en meest gebruikte tools voor softwaredocumentatie en technisch schrijven te bekijken.
Hulp bij het schrijven van tools
Help-auteurstools spelen een belangrijke rol bij softwaredocumentatie en technisch schrijven, omdat ze het veel gemakkelijker maken om softwaredocumentatie te ontwerpen, schrijven, publiceren en onderhouden. Ze stellen u in staat tijd en moeite te besparen bij het maken van allerlei soorten hulpmateriaal, zowel voor eindgebruikers als voor andere programmeurs / medewerkers.
MadCap Flare is een van de meest populaire hulpmiddelen voor het schrijven van hulp dankzij de uitgebreide selectie functies waarmee u veel meer kunt doen dan alleen het schrijven van hulpdocumentatie. MadCap Flare is ontworpen voor geavanceerde op onderwerpen gebaseerde authoring, single-source publishing en content management. Hiermee kunt u Help- en klantenondersteuningswebsites, veelgestelde vragen, kennisbanken, online leercentra, handleidingen, beleids- en procedurehandleidingen en meer maken. De functies van MadCap Flare maken het gemakkelijker om dezelfde inhoud in meerdere kanalen te hergebruiken en deze snel op verschillende platforms te publiceren.
Document360 is een ander veel gebruikt webplatform waarmee u allerlei kennisbanken en helpmaterialen kunt bouwen, publiceren en bijwerken. Het heeft ook multi-profielfunctionaliteit, waaronder een eenvoudige Markdown-teksteditor, Category Manager om de kennisbasisstructuur op te bouwen, functies voor het aanpassen van landingspagina's, terugdraaien van versies, back-up en herstel, flexibele aanpassing van rollen en machtigingen, enzovoort.
Adobe RoboHelp is een andere krachtige alternatieve tool voor het schrijven van hulp, die een iets andere selectie van functies biedt in vergelijking met MadCap Flare en Document360. Adobe RoboHelp biedt met name eenvoudig publiceren in meerdere indelingen, waardoor u inhoud kunt publiceren naar een breed scala aan populaire uitvoerindelingen, waaronder Frameless Responsive HTML5, PDF, Microsoft Help (CHM) en nog minder gebruikelijke indelingen zoals EPUB 3, KF8 en MOBI.
Het grote voordeel van Help+Manual is de eenvoudige interface die het zeer toegankelijk en gebruiksvriendelijk maakt, samen met de volledige functionaliteit van een WYSIWYG XML-editor, publicatie via meerdere kanalen, volledige ondersteuning voor multimedia en complexe modulaire projecten, Webhelp-tool voor naadloze integratie van de documentatie in actieve websites, enzovoort.
ClickHelp biedt ook een behoorlijk krachtig webplatform voor softwaredocumentatie in de vorm van kennisbanken, veelgestelde vragen, zelfstudies en andere Help-indelingen. Ondersteunt meerdere formaten zoals Word, HTML, RTF, CHM, ODT, CHM, HTML5 Web Help, PDF, DOCX, etc. Enkele kenmerkende functies van ClickHelp zijn gepatenteerde volledige tekstzoekopdrachten die het gemakkelijker maken om specifieke onderwerpen of artikelen te vinden voor zowel auteurs en gebruikers, evenals een keuze uit verschillende vooraf gebouwde sjablonen voor het ontwerp van de documentatie.
Tools voor het vastleggen van schermen
De meeste softwaredocumentatie en helpmaterialen moeten schermafbeeldingen bevatten, dus het zou logisch zijn om een kort overzicht te maken van de beste tools voor het vastleggen van schermen die er zijn.
Als u Windows als uw besturingssysteem gebruikt, wordt het geleverd met een knipprogramma, waarmee u schermafbeeldingen kunt maken van het volledige scherm, afzonderlijke vensters of een deel van het scherm, en het pengereedschap kunt gebruiken om enkele specifieke delen van de schermafbeelding te markeren.
FireShot is een populaire browserplug-in die vrijwel alle moderne browsers ondersteunt, zoals Chrome, Firefox, Internet Explorer en Opera. Hiermee kunt u de hele webpagina of een specifiek deel ervan vastleggen.
SnagIt is een complexere tool voor het vastleggen van schermen. Hiermee kunt u scrolgebieden van elke pagina vastleggen en video-opnamen ondersteunen. U kunt deze afbeelding ook gebruiken om GIF's te maken en specifieke acties op het scherm op te nemen.
Spelling- en grammaticacontrole
Het is ook belangrijk om ervoor te zorgen dat uw documentatie correct is geschreven zonder grammatica- en interpunctiefouten. Hier zijn enkele hulpmiddelen die u zullen helpen fouten in uw teksten op te sporen en te herstellen.
Een van de meest populaire gratis online spelling- en grammaticacontroles. Schriftgeleerden kunnen meer dan 250 verschillende soorten fouten identificeren en corrigeren, waaronder zelfstandige naamwoorden, voornaamwoorden, voorzetsels, werkwoorden, homoniemen, interpunctie, typografie, enzovoort.
Naast het tonen van typefouten en fouten in uw teksten, biedt Grammar.com u relevante suggesties, evenals grammaticaregels en een e-boek om uw schrijven te verbeteren (alles gratis).
'Hoe geweldig je bibliotheek ook is en hoe intelligent het ontwerp ook is, als jij de enige bent die hem begrijpt, heb je er niets aan. Documentatie betekent niet alleen automatisch gegenereerde API-referenties, maar ook geannoteerde voorbeelden en diepgaande tutorials. Je hebt ze alle drie nodig om ervoor te zorgen dat je bibliotheek gemakkelijk kan worden overgenomen”, zegt Nicholas Zakas, een bekende front-end engineer en auteur van boeken. Daarom hebben we vandaag besloten om enkele van de beste en meest gebruikte tools voor softwaredocumentatie en technisch schrijven te bekijken.
GO TO FULL VERSION