Document reviews

Sonja de Bruin (sonja@themis-consultancy.nl)24 jan 2010Kwaliteitsmanagement

Inhoud

•Definitie•Doelen•Informele reviews•Formele reviews

•Rollen•Inspectie•Technische review•Walkthrough

•Procedure•Tips

Definitie

Een review is een kritische evaluatie van een product

Doelen van document reviews

•Het vinden van Defects zo vroeg mogelijk in het development traject (kostenbesparing)•Het verbeteren van de kwaliteit van het product•Kennis overdracht•Voldoen aan standaarden•Consistentie tussen documenten•Team building

Informele reviews, kenmerken

•Review uitgevoerd door collega’s •Reviews zijn niet gedocumenteerd, volgen geen vastgelegde procedure•Geen beperking aan het aantal pagina’s dat een reviewer moet reviewen•Geen specifieke opdracht per reviewer•Niet altijd een review meeting•Wordt geen data verzameld om het review proces te verbeteren

Formele review typen volgens IEEE 1028

• Inspectie• Technische review• Walkthrough

• Management review• Een systematische review van een project op verzoek van

management, waarbij de status van het project wordt geëvalueerd tegen het plan

• Audit• Een onafhankelijke doorlichting van een product of proces tegen een

overeengekomen basis.

Formele review typen in de tijd uitgezet

Schrijven van een document

Inspectie

Technische review

Walkthrough

Rollen in formele reviews (1)

•Moderator•Leidt het review proces•Bepaalt de review strategie en het review team•Zit de review meeting voor•Checkt rework

•Auteur•Onduidelijkheden naar voren brengen•Begrijpen van de gevonden defects•Vastleggen van ieder genoemd defect en de suggesties tot verbetering in de logging form

Rollen in formele reviews (2)

•Schrijver•Vastleggen van ieder genoemd defect en de suggesties tot verbetering in de logging form

•Reviewers•Zoeken naar en vastleggen van defects

Inspectie, kenmerken (1)

•Doelen•Het vinden van defects•Het verifiëren van de product kwaliteit•Het uitwisselen van informatie

•Fase: document is bijna klaar•Reviewers: collega’s•Voorbereiding

•Formele voorbereiding gebaseerd op rollen•Slow checking rate

Inspectie, kenmerken (2)

•Review meeting•Formeel•Focus op vastleggen•Geen discussie•Moderator zit de meeting voor

•Logging door de auteur•Benodigd materiaal

•Het document onder review•Brondocumentatie•Standaarden•Regels en checklists

Inspectie, kenmerken (3)

•Process lead: moderator•Team grootte: 2-6 personen•Follow up: formele check door de moderator en reviewers

Technische review, kenmerken (1)

•Doelen•Bespreken van technische alternatieven•Het bereiken van consistentie•Het informeren van anderen

•Fase: het document is voor 70% klaar•Reviewers

•Experts•Collega’s•Soms projectleiders

•Voorbereiding•Rollen gebaseerd op specifieke vragen van de auteur•Niet teveel bladzijden

Technische review, kenmerken (2)

•Review meeting•Discussie•De technische leider is de voorzitter van de meeting

•Logging door de auteur•Follow up: besluiten door de experts over de follow up•Benodigd materiaal: Document onder review•Process leader: technische leider heeft de rol van moderator•Team grootte: 4-6 personen

Walkthrough, kenmerken (1)

•Doelen•Verzamelen van informatie•Evalueren van de inhoud•Consensus bereiken•Van elkaar leren

•Fase: start van een document•Reviewers:

•Collega’s•Technische leiders•Deelnemers buiten de software discipline

•Meeting•Presentatie-achtig•Auteur leidt de meeting

Walkthrough, kenmerken (2)

•Voorbereiding:•Niet uitgebreid•Defects worden gevonden tijdens de meeting•Rollen zijn niet nodig

•Logging: door schrijver•Follow-up: moderator check of de actiepunten zijn uitgevoerd•Benodigd materiaal: document under review•Process leader: moderator•Team grootte: 5-8 personen

Review procedure

Tips (1)

•Algemeen•Review het product, niet de auteur•Beperk het aantal deelnemers in de review meeting•Duur review maximaal 2 uur•Plan follow-up akties

•Reviewers•Bereid de meeting goed voor•Gebruik geen negatieve woorden•Geef de moderator de ruimte om orde te houden•Team building

Tips (2)

•Moderator•Cancel de meeting als de voorbereiding of deelname onvoldoende is•Sta geen eindeloze discussies toe•Check dat besluiten worden vastgelegd•Gebruik het actie-lijst-mechanisme

•Auteur•Start de voorbereiding zo vroeg mogelijk•Check spelling en grammatica•Beschouw een review als een uitstekende gelegenheid om iets te leveren•Beschouw opmerkingen niet als persoonlijk