15 technical writing tips (+2)

tips

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:

  1. Gebruik een formele stijl, word niet familiair.
  2. Wat is het publiek waarvoor je schrijft?
  3. Wanneer wordt je documentatie gebruikt? Wees je daarvan bewust.
  4. Gebruik een inhoudsopgave.
  5. Schrijf  taakgericht.
  6. Zorg voor een natuurlijke flow in de handleiding.
  7. Gebruik ‘chunks’/ ‘snippets’, stukjes tekst, voor hergebruik.
  8. Gebruik labels.
  9. Screenshots.
  10. Illustraties (plaatjes, diagrammen etc.)
  11. Tabellen
  12. Maak een index.
  13. Web
    Mijn tip: Ga voor omnichannel – pas je output aan, pdf – online help [pc-tablet-smartphone].
  14. Review.
  15. Test.

En nog een tip van mij: schrijf simpel en schrap overbodige woorden. Een mooi voorbeeld in de video hieronder.

Geef een reactie

Vul je gegevens in of klik op een icoon om in te loggen.

WordPress.com logo

Je reageert onder je WordPress.com account. Log uit /  Bijwerken )

Google photo

Je reageert onder je Google account. Log uit /  Bijwerken )

Twitter-afbeelding

Je reageert onder je Twitter account. Log uit /  Bijwerken )

Facebook foto

Je reageert onder je Facebook account. Log uit /  Bijwerken )

Verbinden met %s

Blog op WordPress.com.

Omhoog ↑

%d bloggers liken dit: