Elke analist schrijft, een goede analist schrapt

Elke analist schrijft, een goede analist schrapt

Ronald Koenis

Als analist schrijf je veel: probleemanalyses, opties, afwegingen, oplossingen en ontwerpen. In dit artikel lees je hoe je tijd kunt besparen voor jezelf en de mensen met wie je te maken hebt. Door te schrijven en vooral ook te schrappen.

“Schrijven is schrappen”

Dit is de titel van een boek van Godfried Bomans vol adviezen om beter te schrijven. De titel komt terug in deze quote: “Ik rust niet voor ik de zin gevonden heb die mijn bedoeling zo nauwkeurig en zo bondig mogelijk weergeeft. De taal is een handschoen die strak om het huis van de inhoud getrokken is. Je moet er een heleboel weggooien voor je die ene vindt die precies past. Schrijven is schrappen. Schrijven is wat er overblijft.”

“Schrijven is schrappen” is een veel gehoord advies en het wordt vaak omgezet naar “Houd het kort en simpel”. Dit is echter té simpel en niet onomstreden (zie Taalschrift). De onderwerpen van een analist zijn niet altijd kort en simpel en je moet de inhoud volledig overbrengen; diepgang blijft nodig. Maar denk na over hoe je dat efficiënt kunt brengen.

Tekstvermijdend gedrag

Een boodschap kan ook zonder woorden overgebracht worden; een plaatje zegt meer dan duizend woorden. Maar let op: een plaatje zónder woorden zegt helemaal niets. Er zijn meer tekstvermijdende hulpmiddelen:

  • Terugkerende structuren
    Terugkerende structuren zie je in onze templates en standaarden. We gebruiken afgesproken vormen zoals bijvoorbeeld bij User Stories: Als … wil ik dat … zodat … , of bij acceptatiecriteria: Stel … Als … dan … . Daarnaast kan je tekst vermijden door in grote documenten elk hoofdstuk dezelfde structuur te geven.
  • Grafische modellen
    Grafische modellen zoals procesmodellen en domeinmodellen mogen natuurlijk niet in dit rijtje ontbreken. Modellen kunnen, zeker als je ze combineert met een glossary, een boodschap heel efficiënt overbrengen.
  • Lijstjes of Matrixen.
  • In plaats van de tekst herhalen, kan je beter verwijzen. Maar let op: verwijzingen kunnen het lezen ook lastig maken. Bij DiVetro hanteren we de richtlijn dat doublures wel zijn toegestaan als dat de leesbaarheid vergroot. Als je dezelfde tekst echter voor een derde keer kopieert, is een verwijzing beter. Anders ga je nat bij het onderhouden van de teksten.

Tekstverbeterend gedrag

Als je dan toch moet schrijven:

1. Vermijd het werkwoord worden

Hanteer een actieve vorm. Zie hier een Use case omschrijving uit de praktijk:

Deze use case beschrijft hoe ontvangen leveringen van RegisterX-mutaties via de centrale voorziening X-ontsluiter door OnsSysteemY op gezette tijden wordt verwerkt. OnsSysteemY verwerkt pas een opvolgende (nog te verwerken) levering indien de vorige levering in haar geheel succesvol is verwerkt. Een aangeboden opvolgende levering wordt alleen verwerkt indien de mutatieperiode aansluit op de laatst verwerkte levering.

Inhoudelijk klopt deze use case, maar het kan ook zo:

OnsSysteemY verwerkt elke dag een levering van mutaties van de X-ontsluiter. Voorwaarden zijn:

  • De mutatieperiode sluit aan op de vorige levering;
  • OnsSysteemY heeft de vorige levering succesvol verwerkt.

Minder woorden en een eenvoudigere denklijn!

2. Vermijd herhalingen … dus

Herhalingen zijn een valkuil waar met mij vele collega’s geregeld intrappen. Eerst iets stap voor stap uitleggen om daarna hetzelfde in andere woorden nog een keer te vermelden. Dus alsof je de inhoud twee keer uitlegt, maar dan net iets anders verwoord. Precies zoals ik net heb gedaan 😉

3. Vermijd toevoegingen

Als analist stuit je op veel details. Dit is logisch want de oplossing schuilt vaak in de details. Maar laat die details weg als het niet nodig is voor de oplossing zelf. Want voor je het weet werkt het verwarrend. Ik hoor het mijn teamlid nog zeggen: “Kan die zin niet gewoon weg? Want dan snap ik het”. Een ander treffend voorbeeld is de conversieregel die ik heb ontworpen, waarbij een conversie wel verkeerd gespelde eenduidige uitspraken mocht omzetten, maar correct geformuleerde uitspraken met een verwijzing naar een toelichting juist niet.

Samenvatting

Als analist

Wil ik kort en bondig schrijven zonder overbodige tekst

Zodat

  • De lezer mijn boodschap snel begrijpt
  • Mijn boodschap helder is
  • Ik, en jij dus ook, minder hoef te onderhouden

Zo houden we tijd over voor een volgende User Story. Of om een lekker dik boek te lezen.

Blijf op de hoogte

Vond u dit artikel interessant? Via de knoppen hieronder kunt u het artikel eenvoudig met uw netwerk delen. Heeft u opmerkingen of suggesties? U kunt ze eenvoudig delen via het reactieformulier onderaan de pagina.

Lees hier onze overige publicaties en schrijf u hieronder in voor onze nieuwsbrief. Zo ontvangt u elke maand automatisch een overzicht van onze recente publicaties in uw mailbox.

DiVetro Team - Ronald Koenis

Ronald Koenis is een senior analist die meer dan 25 jaar in het IT vak zit. Zijn brede ervaring heeft hij in diverse rollen opgedaan. Hij was onder meer informatie analist bij Albert Heijn, projectleider bij gemeente Almere en is momenteel information engineer bij het Kadaster en senior ontwerper bij de Rechtspraak. Hij is in staat complexe IT oplossingen zo weer te geven dat die voor de business te begrijpen is en tegelijkertijd voldoende specifiek is, zodat IT er mee aan de slag kan.

Geen reactie's

Geef een reactie