Werkwijze

In de voorbereidingsfase verzamel en organiseer ik alle gegevens over het product, de doelgroep en de verwachtingen van de opdrachtgever.

In deze fase kan aandacht worden besteed aan de stand van zaken van de documentatie bij de opdrachtgever.

Welbeschouwd is de gebruikersdocumentatie geen op zichzelf staand product, maar onderdeel van het grotere geheel van de bedrijfsdocumentatie. Het gemak en de snelheid waarmee gebruikersdocumentatie kan worden geproduceerd en onderhouden, hangt samen met de kwaliteit van de overige bedrijfsdocumentatie.

In veel bedrijven bestaan er voor de productie en het onderhoud van de bedrijfsdocumentatie geen goede procedures. De verschillende afdelingen produceren ieder hun eigen documenten, voor hun eigen doelgroep(en). Zo ontstaat er een grote hoeveelheid informatie, die slecht op elkaar is afgestemd en na verloop van tijd wordt het steeds moeilijker de documentatie te onderhouden.
Ik zie het als een uitdaging om een bijdrage te leveren aan de verbetering van de documentatie-omgeving binnen uw bedrijf. Bedrijfsinformatie wordt een stuk overzichtelijker als deze is ondergebracht in een informatiebeheersysteem dat losstaat van de feitelijke documenten. Alle informatie over een product wordt daarbij vastgelegd in onafhankelijke, op zich zelf staande componenten, waaruit elk gewenst document kan worden opgebouwd.

In overleg met de opdrachtgever maak ik een gedetailleerde planning, waarin duidelijke deadlines zijn opgenomen en tijdstippen voor eventuele veranderingen aan het product die een impact hebben op de ontwikkeling van de documentatie.

Outline en huisstijl

Ik maak een structuur voor de hele documentatieset en een outline voor elk onderdeel van de documentatie. Deze worden aan de opdrachtgever voorgelegd ter goedkeuring.

Desgewenst worden een voorbeeldhoofdstuk en een voorlopige versie van het te gebruiken template ontwikkeld. Indien online help onderdeel is van de opdracht, wordt het voorbeeldhoofdstuk geconverteerd naar online help.

Dit wordt aan de opdrachtgever voorgelegd ter goedkeuring van schrijfstijl en presentatie.

Versies

Eerste versie
Op basis van de outline wordt de eerste versie van de documentatie ontwikkeld. Deze versie bevat volledig uitgewerkte hoofdstukken. Deze versie bevat echter niet de definitieve versie van de illustraties en wordt niet in de definitieve layout gepresenteerd. De eerste versie van de documentatie wordt eerst intern gereviseerd door mij en vervolgens aan de opdrachtgever aangeboden ter goedkeuring van de inhoud.

Tweede versie
Ik verwerk het commentaar op de eerste versie. De tweede versie van de documentatie wordt eerst intern gereviseerd door mij en vervolgens aan de opdrachtgever aangeboden ter goedkeuring van de inhoud.

Beta versie
Ik verzorg eventuele screen shots en illustraties. Ik pas de voorgestelde pagina-layout toe op basis van de bestaande huisstijl van de opdrachtgever of op basis van een door mij voorgestelde en ontwikkelde stijl. De beta versie van de documentatie wordt aan de opdrachtgever aangeboden ter goedkeuring van de inhoud en de stijl.

Definitieve versie
Ik verwerk alle commentaar en maak inhoudsopgave, index en glossary.