Hendrikx Van der Spek

Mediumkeuze van technische documentatie

Onderzoek altijd welk medium het meest geschikt is om uw informatie over te brengen. Soms is een handleiding de beste keuze, maar een andere keer heeft een gebruiker meer aan een online help of een training.

  • Bekijk waar de documentatie gebruikt gaat worden. In een fabriekshal of garage is het waarschijnlijk handiger om een papieren handleiding (liefst geplastificeerd) te hebben dan online help (want geen pc aanwezig).
  • Weeg de voor- en nadelen van verschillende media af. Een online help is altijd bij de hand, maar kan hoogdrempelig zijn als de gebruiker toch al weinig computerervaring heeft. Een helpbestand is meestal wel to the point, zodat de gebruiker minder hoeft te lezen.

    Een handleiding heeft als voordeel dat de gebruiker niet per se achter de pc hoeft te zitten en kan bladeren in zijn eigen tempo. Nadelen zijn een lange productietijd met vaak hoge kosten, de handleiding kan kwijtraken en in een handleiding staat vaak meer tekst dan in een helpbestand.
  • Ken uw randvoorwaarden. Hoeveel ervaring hebt u met het maken van de verschillende soorten documentatie? Hoeveel tijd en geld hebt u beschikbaar? Als er niet veel tijd of beschikbaar is, kies dan niet voor een – voor u – onbekend medium. Is er niet veel budget, dan is een papieren handleiding wellicht niet de slimste keuze.

|