Seven tips for a better Search

Do the users of an application or a machine read a manual? Forget it! They might scan the Requirements section and that's it. Until something drastically goes wrong. Their phone is dead, so they cannot call support. Where is that manual? Oh..,<peep> how do I access this online help. Your user will not be in... Lees verder →

Alerts are precious, use them sparsely

You find them in nearly every manual; alerts. They tell the reader something special. Be it info or note, caution or warning. There are guidelines on how to create them, but no standards, which is strange. Let's have a look at definitions, stylisation and more. Definitions Note / Info/ Tip: handy information for the user... Lees verder →

MadCap Flare – Micro content

The 2019 release of MadCap Flare might contain the buzzword of the future: micro content. They describe it as: Text, images, video that can be consumed by a reader in about 10-20 seconds. MCF rightly sees that the demand for micro content is growing; online FAQs, chatbots, augmented reality instructions, call outs, tooltips..a lot comes... 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 →

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 →

15 technical writing tips (+2)

Op Youtube staan verschillende filmpjes over technical writing. De een is te langdradig, de ander neem te veel hooi op de vork. Het filmpje in deze blog geeft een handige opsomming waar je als technical writer aan moet denken. In iets meer dan acht minuten passeert bijna alles de revue. In deze volgorde: Gebruik een... Lees verder →

u3d – plaatje gaat boven praatje

Welkom lezer! Ben je getrokken door het 'plaatje' uit de titel of door 'u3d'. In dat laatste geval weet je iets over machinehandleidingen; dat er bij bijna elke machine een installatie-, een operator, en een service handleiding wordt geschreven. In al die documenten wil je zo weinig mogelijk tekst. De gebruikersgroep staat nu eenmaal niet... Lees verder →

Acht redenen om een Quick reference guide te maken

Weer eens een handleiding van honderden pagina's over de schutting gemikt? Alles tot in detail beschreven, niets overgeslagen, maar niemand echt enthousiast over je werk? Probeer dan eens een quick reference guide (QRG), een handig document waarin de belangrijkste functionaliteit van je applicatie, machine of product wordt beschreven. Sommige zijn niet meer dan enkele pagina's... Lees verder →

Machine CE ?! Moet ook de documentatie mee.

Machines die binnen Europa verhandeld worden moeten aan veel eisen voldoen. Een CE-markering is de beloning na gedaan werk. Deze Europese richtlijn 2006/42/EG voor machines is een lijvig epistel waarin ook documentatie wordt behandeld.  Aan welke eisen moet deze voldoen? Taal Over de gebruikte taal wordt het volgende vastgesteld: Bij iedere machine moet een gebruiksaanwijzing... Lees verder →

Blog op WordPress.com.

Omhoog ↑