
Atelier
Een brede, donkere naamkop met links een vierkant portret en daaronder twee kolommen.
Bekijken & gebruikenEen rustige editie met een open naamkop en verticale lijnen die projectgegevens en toelichting verbinden.
Lijn gebruikt een open naamruimte en fijne verticale lijnen om projectgegevens en toelichting bij elkaar te houden. De lijnen helpen de lezer van rol en periode naar de inhoud van dezelfde opdracht te kijken.
Technisch schrijvers, trainers en contentspecialisten kunnen het onderscheid laten zien tussen wat ze deden en voor wie het bestemd was. De vorm is handig wanneer de stukken binnen een opdracht verschillen, maar één duidelijk doel hadden.
Benoem wie jouw instructie of uitleg gebruikt en welke handeling diegene daarna kan uitvoeren. Leg vast hoe je ontdekte welke uitleg daarvoor nodig was.
Liep de installatie met twee monteurs door, herschikte de instructies op werkvolgorde en liet een nieuwe gebruiker de handleiding testen.
Gebruik het projectblok voor de gegevens waarop de lezer zich oriënteert. Zet het doel, je bijdrage en het resultaat samen in de toelichting bij datzelfde project.
Vermeld een versie alleen als die betekenis heeft voor de ervaring, bijvoorbeeld als je documentatie voor een migratie naar een nieuw platform schreef.
Noem beide gebruikersgroepen en beschrijf hoe je de instructies voor hen organiseerde. Bijvoorbeeld een snelstart voor monteurs en een naslagdeel voor beheerders.
Bundel opdrachten die horen bij hetzelfde product of onderhoudstraject. Geef met één of twee voorbeelden aan welk soort wijzigingen je doorvoerde.
Vermeld wie je instructies toetste en noem één belangrijke wijziging die uit die test volgde. Daarmee krijgt de review betekenis.
Gebruik verschillende werkwoorden. Schrijf bijvoorbeeld dat jij de werkwijze observeerde en instructies opstelde, waarna een redacteur terminologie en stijl controleerde.