Uit het leven van een technisch schrijver

Zucht, steun, jank? De dagen vaal en grauw? Buiten regen en binnen werk dat maar niet opschiet? Collega's die niet meewerken. Een manager die je weer eens onderaan het lijstje met prio's zet. 'Nothing works', om het eens met 'good old' Catweazle te zeggen. Kop op, morgen straalt de zon. Regent het schouderklopjes. Doe je... Lees verder →

Documentatie van de toekomst

Anne Beebe, director of content publishing bij Microsoft, raakte in 2014 van de ene op de andere dag 70% van haar documentalisten kwijt. Het werk bleef. Een andere opzet en een andere functie-inhoud van de overgebleven documentalisten moesten soelaas bieden. Dit is documentatie nieuwe stijl. Met de volledige steun van haar baas kwam Beebe met... Lees verder →

API-documentatie met MadCapFlare

Op dit blog zijn al vaker richtlijnen aangegeven voor het schrijven van API-documentatie en het belang daarvan. API-documentatie; een overzicht API: “it’s the documentation, stupid!” MadCapFlare doet nu ook een duit in het zakje met een white paper. Immers, je kunt met deze tool html-pagina's maken en die op een website zetten. Moeilijk doen met... Lees verder →

Fouten maken we allemaal…

Weer je neus gestoten, weer een fout gemaakt. Is het dan nooit perfect? Nee, het is nooit perfect. Lees een tekst drie, vier, vijf keer over en bij de zesde keer haal je er nog fouten uit. Je neus stoten hoort bij het vak van technical writer. John Hewitt somt een aantal veel gemaakt fouten... Lees verder →

Confluence : de voor- en nadelen voor documentatie

Kort geleden begon ik op LinkedIn een discussie over de documentatievoor- en nadelen van Confluence. Immers, Confluence, is vooral handig om informatie te delen. Je maakt een groep (space) en koppelt daar pagina's aan (spaces). Aan beide koppel je personen, die acties toebedeeld krijgen en over rechten bezitten.  In een omgeving waar samenwerking voorop staat... 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 →

Documentatie 2017 … trends zetten niet door

Vorig jaar was ik tijdens Information Energy  getuige van de traagheid van verandering. Een samenspraak over Information 4.0 kwam krakend tot stilstand toen een van de deelnemers opmerkte dat we nu al vele, vele jaren html gebruiken en er in de tussentijd weinig is bijgekomen, laat staan veranderd. Een onderzoek van DCL, een Amerikaans consultancybedrijf... Lees verder →

Blog op WordPress.com.

Omhoog ↑