Bij de start van een project bepalen we wat er moet gebeuren. Ook verzamelen we zo veel mogelijk bestaand materiaal. Op basis daarvan schrijven we een plan of offerte.
Dat kan gaan om een uitgebreid plan voor verschillende soorten documentatie die nodig zijn bij een product, maar het kan ook gaan om een kort voorstel voor het schrijven van één handleiding, met planning en kostenplaatje.
We bepalen in overleg welk type en welke vorm van documentatie het meest geschikt is voor het doel en de doelgroep van uw product of dienst.
Als u zich kunt vinden in het plan en/of de offerte, gaan we bij u aan de slag:
- We verzamelen bestaande informatie (op papier of digitaal: brochures, specificaties, procedures, tekeningen, schema’s, etc.). We bepalen in onderling overleg de aanpak.
- We bepalen het doel en de doelgroep van de documentatie. We interviewen iedereen die verstand heeft van uw product of dienst (Ontwikkelaars/R&D, QA, Sales & Marketing, Trainers, Service engineers, etc).
- We stellen een inhoudsopgave op (outline) voor ieder te schrijven document. In het geval van online help ontwerpen we een structuur. Het resultaat krijgt u ter controle.
- Nu gaan we eindelijk schrijven. De outline/structuur vullen we met informatie. Het resultaat is een eerste concept. Ook dit concept krijgt u ter review.
- Ongetwijfeld heeft u nog opmerkingen of nieuwe informatie die in de tekst terecht moet komen. Dat verwerken we netjes. Indien nodig, krijgt u een 2e concept ter review.
- Als alles naar tevredenheid is, generen we het eindproduct. Daarmee zijn we dan voorlopig klaar.
Maar … beschouw het schrijven van documentatie altijd als een iteratief proces: iedere verandering in een product kan een wijziging in documentatie tot gevolg hebben.
Gedurende het ontwikkeltraject is er steeds contact met uw mensen. Dat is logisch, want de specialistische kennis zit in de hoofden van uw mensen. We verwachten van u dan ook dat u:
- zorgt dat benodigde informatie tijdig beschikbaar is (bijvoorbeeld (ontwerp)specificaties, grafisch materiaal, technische tekeningen)
- ‘subject matter experts’ beschikbaar stelt voor het beantwoorden van vragen en het geven van uitleg
- zorgt dat teksten tijdig gecontroleerd worden op inhoudelijke juistheid.
