Swagger for API documentation

Swagger uses the easy to learn YAML to produce reference documentation for REST API's. If you have a simple API, Swagger could be the tool to document it. The Swagger UI, depicted below,  gives the user a chance to practice with the API or get a simple overview of its functionality. The reference documentation written... Lees verder →

API documentation : the description

A small company hosted an API and the UI was a Software as a System (SaaS). So they created the reference documentation and boasted that no manual was needed for their UI. It was so intuitive a kid could work with it. To my surprise there were many pages on their website explaining the functionality... Lees verder →

Negen technical writer mythes

Laatst had ik een gesprek met een manager: hoe krijgt mijn team van technical writers meer gewicht? Nu hangen ze er wat bij binnen het bedrijf. Hoog tijd om de mythbusters van stal te halen. Dan wordt veel duidelijk over het werk van de technical writer, zijn persoonlijkheid, zijn waarde voor het bedrijf  en zijn... Lees verder →

7 tips voor een chatbot schrijver

Je bedrijf begint met een chatbot. Of jij even de teksten wilt schrijven. Die handleiding heeft een klant straks niet meer nodig. Het online vraag- en antwoordspel zal de helpdesk ontlasten en het bedrijf een vooruitstrevend imago geven. Jij zegt: "Eh..." of je sputtert dat die handleiding echt nodig is. En hoe zit het me... Lees verder →

6 tips bij het schrijven van release notes

Het product is de deur uit en nu komen de verbeteringen. Nou ja, er zijn ook links en rechts nogal wat foutjes opgelost. En van de product manager moest die nieuwe functionaliteit er echt in. De testers gebruiken gelukkig een applicatie die de bugs en hun status moeiteloos uitspuwt. En de functionaliteit wordt net op... Lees verder →

Elke klant zijn eigen handleiding? Geen probleem!

Deze week kreeg ik de vraag of je in MadCapFlare makkelijk vanuit hetzelfde project voor elke klant een eigen handleiding kunt genereren. Dat is geen probleem.  Hieronder een uitleg om voor drie verschillende klanten elk een afzonderlijk bestand als pdf te genereren. Voor online-help werkt deze procedure niet. Het proces is als volgt: Targets (output... Lees verder →

Blog op WordPress.com.

Omhoog ↑