The Product is Docs

Christopher Gales en zijn team van documentatieschrijvers schreven in samenwerking deze bundel The Product is Docs: Writing technical documentation in a product development group (2017). De bundel bevat alfabetisch geordende essays over hun werk: het documenteren van de producten van Splunk voor klanten, beheerders en gebruikers.

Het is dus geen leerboek dat je van voor naar achter bestudeert. Lees wat je interessant lijkt of wat van toepassing is op jouw werksituatie. Het maakt nogal wat uit of je in een grote IT-organisatie werkt en schrijven je hoofdtaak is, of bijvoorbeeld in een welzijnsorganisatie, waar je gebruikers wilt helpen met heldere instructies bij hun cliëntensysteem. Maar voor alle IT-documentatiefuncties vind je relevante tips in dit boek.

Alle essays in de bundel zijn luchtig en soms humoristisch geschreven. Dus dat leest lekker. Soms wordt het technisch.

Dit boek (201 pagina's) is uitgebracht door Amazon. Je kunt een versie voor je Kindle kopen voor ongeveer € 5 of een paperback bestellen in de VS. De opbrengst gaat naar een goed doel.

ISBN 1973589400

Vóór The Product is Docs las ik Modern Technical Writing: An Introduction to Software Documentation uit 2016 van Andrew Etter, die bij Amazon werkt. Dit boek is alleen verkrijgbaar voor de Kindle (ASIN B01A2QL9SS), is veel dunner (46 pagina's) en kost nog minder. Hoewel het meer ingaat op de (software)keuzes die je maakt voor het documenteren van software en dus technischer is, heeft het dezelfde no-nonsensebenadering en humor. Je steekt er gegarandeerd wat van op als je technische documentatie schrijft.