Productdocumenten

De omvang en gedetailleerdheid van productdocumentatie is sterk afhankelijk van de context van het werk. In plaats van afzonderlijke documenten voor te schrijven, biedt Praxis een lijst van gebieden waaruit geschikte documenten moeten worden samengesteld in overeenstemming met de behoeften van het project of programma.

Dit kan resulteren in een eenvoudige aanpak met één document per product of een uitgebreidere aanpak met aparte documenten voor productbeschrijvingen, configuratie-items en kwaliteitsverslagen.

Gemakshalve zijn de velden in drie secties onderverdeeld. Wanneer deze worden uitgebreid tot afzonderlijke documenten, zullen velden vaak moeten worden gekopieerd tussen de afzonderlijke documenten.

 

Beschrijvende Informatie

• Identificatiekenmerk

• Een uniek identificatiekenmerk dat kan bestaan uit componenten zoals een project- of programmacode; productcode; versienummer enz.

• Titel

• De naam waaronder het product bekend staat.

• Beschrijving

• Een beschrijving van het product, eventueel met vermelding van het doel en hoe het in de totale product past.

• Samenstelling

• Voor een eenvoudig product kan deze rubriek volstaan om de componenten en de aard van het product te beschrijven. Voor complexere producten zullen kruisverwijzingen naar technische specificaties nodig zijn.

• Eigenaar

• Indien het product een concreet resultaat is, is de eigenaar de partij aan wie het product wordt overgedragen. Anders is het een lid van het managementteam die verantwoordelijk is voor het accepteren van het product voordat het wordt geïntegreerd in hen totale product.

• Kruisverwijzingen

• Koppelingen naar andere documenten die meer informatie over het product geven, bijv. risicoregister, stakeholderkaart, leerpuntenlogboek, enz.

 

Ontwikkelinformatie

• Ontwikkelaar

• De persoon, het team, de afdeling of contractant die verantwoordelijk is voor de ontwikkeling van het product.

• Geplande data

• Wanneer het product gepland is om ontwikkeld te worden.

• Werkelijke data

• Wanneer het product daadwerkelijk is ontwikkeld.

• Kwaliteitscriteria

• Dit zijn de kwaliteitscriteria die in het kader van de kwaliteitscontrole getest zullen worden. Dit kunnen verwijzingen zijn naar externe kwaliteitsnormen, criteria die uniek zijn voor het product of een combinatie van beide.

• Kwaliteitstoleranties

• Voor elk kwaliteitscriterium moet een lijst worden opgesteld van de meetbereiken waarbinnen het product aanvaardbaar zou zijn.

• Kwaliteitscontrolemethode

• Hier zullen de toe te passen controlemethodes worden gedefinieerd. Deze kunnen variëren van kwalitatieve gebruikersbeoordelingen tot mechanische inspectie en statistische analyse.

• Verantwoordelijkheden voor kwaliteitscontrole

• De personen of groepen die verantwoordelijk zijn voor het implementeren van de kwaliteitscontrolemethodes.

• Testdata

• De geplande en geraamde data voor de meeste test- of reviewactiviteiten zijn volledig afhankelijk van een opleveringsschema dat regelmatig wordt bijgewerkt. Om dubbel werk te voorkomen, kan voor de geplande en de te verwachten data eenvoudigweg worden verwezen naar het betrokken opleveringsplan. Dergelijke kruisverwijzingen mogen worden aangevuld met informatie zoals "het product moet binnen een week na voltooiing worden getest".

• Testresultaten

• De resultaten van de kwaliteitscontrole kunnen eenvoudig zijn, zoals een goed/afkeuring of uitgebreide testgegevens. Hoe dan ook, de gevolgen van de testresultaten moeten worden gedocumenteerd. Als de kwaliteit acceptabel is, kan het product worden vrijgegeven voor integratie met andere producten of worden overgedragen aan de eigenaar. Als de kwaliteit niet acceptabel is, kan het product worden bewerkt of weggegooid. In sommige omstandigheden kan het mogelijk of noodzakelijk zijn om een product te accepteren dat niet aan de criteria van de sponsor voldoet, maar dat is een beslissing die door de sponsor moet worden genomen.

• Kruisverwijzingen

• Gewoonlijk zullen deze kruisverwijzingen betrekking hebben op leveringsplannen die de context van de geplande en de werkelijke data laten zien.

 

Configuratie-informatie

• Huidige versie

• Een identificatiekenmerk dat de meest recente versie van het product aangeeft. In het onderdeel configuratiemanagement van het scopemanagementplan wordt het systeem gedefinieerd voor het stapsgewijs etiketteren van de versies van een product.

• Status

• Een classificatie van de huidige status zoals gedefinieerd in een configuratiemanagementplan, bv. in ontwikkeling, in beoordeling, goedgekeurd, overhandigd, enz.

• Datum laatste wijziging

• Wanneer de laatste versie van het product werd vrijgegeven voor test of overdracht.

• Vorige versies

• Wanneer de datum van de laatste versie wordt geregistreerd, vervangt deze niet de vorige data. Elk identificatiekenmerk van de "huidige versie" en elke "datum van laatste wijziging" blijven in het document staan om het tijdschema voor de ontwikkeling van het product weer te geven.

• Locatie

• Plaats waar het artikel zich bevindt of waar het is opgeslagen. Dit is van toepassing op een 'zacht product' zoals een elektronisch bestand of een fysiek onderdeel dat voorafgaand aan de installatie kan worden verplaatst. Het is niet relevant voor producten die in het totale product zijn ingebouwd, zoals de funderingen van een gebouw of de kiel van een schip.

• In bewerking door

• De huidige versie van een product kan bij de oorspronkelijke ontwikkelaars of een testteam zijn. Als het product fysiek is en niet kan worden achterhaald, is dit gewoon nuttige informatie.

• In het geval van elektronische bestanden (bijvoorbeeld documenten of computercode) waarbij een download of e-mailbijlage een kopie maakt, is het van vitaal belang om te begrijpen wie de enige autoriteit heeft om aan het product te werken. Dit is essentieel om ervoor te zorgen dat er niet meerdere mensen tegelijkertijd wijzigingen aanbrengen in een product.

• Verbanden

• In dit onderdeel wordt uitgelegd hoe het product samen met andere producten werkt. Dit is het belangrijkste veld bij de beoordeling van een wijzigingsverzoek, aangezien het identificeert hoe een wijziging van dit product gevolgen kan hebben voor andere producten.

 

Specifieke documenten

De kenmerkende inhoud van elk document is samengevat in de tabel aan het einde van deze pagina.

Via het menu met productinformatie kunt u veel verschillende soorten documenten samenstellen. De hieronder beschreven soorten documenten zijn gekozen op basis van het feit dat ze vaak voorkomen in gidsen en methoden voor P3-management. Het is niet de bedoeling dat deze lijst definitief of voorschrijvend is.

• Productbeschrijving

• Dit document is een mini-specificatie voor een bepaald onderdeel van de doelstellingen van het project, het programma of de portefeuille. Het stelt mensen in staat om de gedetailleerde aard, het doel, de functie, het uiterlijk en de acceptatiecriteria van het product te begrijpen. Het moet voldoende informatie bevatten om vast te stellen welke activiteiten nodig zijn om het product te ontwikkelen, te testen en goed te keuren, welke middelen nodig zijn om het te ontwikkelen, wat de kosten van het product zijn en waar nadere informatie te vinden is.

• Productregister

• Dit register vat informatie uit de productbeschrijvingen samen en geeft een productindex en een snel overzicht van hun status. Wordt soms een productchecklist genoemd.

• Kwaliteitsregister

• Het kwaliteitsregister vat de kwaliteitscontrole-activiteiten voor alle producten samen en vormt een centraal referentiepunt voor een potentieel zeer gevarieerd portfolio van kwaliteitscontroledocumenten.

• Configuratie-item

• Dit document bevat de registratie van een item dat onder configuratiebeheer is geplaatst. Het heeft betrekking op informatie zoals geschiedenis, huidige status, versie en verbanden met andere items.

• Statusoverzicht

• Het statusoverzicht geeft een samenvatting van informatie over de huidige status van een gedefinieerde set configuratie-items, bijvoorbeeld 'alle producten die in de volgende maand gereed moeten zijn' of 'alle producten die worden ontwikkeld door XYZ Werkt BV.'. De reikwijdte van het statusrapport moet worden beschreven voordat de informatie in de tabel wordt vermeld.

 

Veld	Product-register	Product-omschrijving	Kwaliteits-register	Configuratie-item	Status-overzicht
Identificatie-kenmerk	X	X	X	X	X
Titel	X	X	X
Omschrijving		X		X
Samenstelling		X
Eigenaar				X	X
Beschrijving kruisverwijzingen	X	X	X	X	X
Ontwikkelaar				X	X
Geplande data	X		X		X
Actuele data	X		X		X
Kwaliteitscriteria		X
Kwaliteits-toleranties		X
Kwaliteits-controlemethoden		X	X
Kwaliteits-verantwoorde-lijkheden		X	X
Testresultaten				X	X
Ontwikkelings-kruisverwijzingen	X	X	X	X	X
Huidige versie	X			X	X
Status				X	X
Datum laatste wijziging				X	X
Vorige versies				X
Locatie				X
In bewerking door				X
Verbanden				X

 

 

Met dank aan het BPUG-team voor de vertaling naar het Nederlands