API-documentatie; een overzicht

Als technical writer kun je op veel gebieden ingezet worden. Software-handleidingen maak je voor de eindgebruiker, een handleiding bij een machine voor de monteur, terwijl je bij API-documentatie voor ontwikkelaars schrijft. API's zijn er in verschillende soorten en maten, maar de meeste zijn REST-api's. Hierbij staat REST voor REpresentational State Transfer. Er gaat iets van...

Software handleidingen …een overzicht

De ene handleiding is de andere niet. Handleidingen komen in soorten en maten. afhankelijk van de branche waarin je als technical writer werkt, heb je met een verschillende soorten handleidingen te maken. In deze blog een overzicht van gangbare  handleidingen bij een software applicatie. De meeste schrijvers zal de Engelse benaming vertrouwder in de oren...

Kleur…minder wordt meer…

Als technical writer maak je zo af en toe een online help voor een applicatie. Een fraaie achtergrond, kleur naar doelgroep en heldere plaatjes met een liefst zo hoog mogelijke dpi zijn slechts enkele van de mogelijkheden om je beoogde publiek te behagen. De opmars van de smartphone en de tablet dreigen echter roet in...

Consistentie…geen koekje, eitje

Zoals een kind gedijt bij rust, reinheid en regelmaat, zo wil een klant consistentie. Ook als het om documentatie gaat. Koekje, eitje, zou je denken, maar niets is minder waar. Hieronder een paar valkuilen en struikelpunten. Stijl Niets is zo moeilijk als een consistente stijl. Onafhankelijk van de grootte van een bedrijf is bij documentatie...