Versiebeheer van machinedocumentatie
Versiebeheer van technische documentatie gaat niet over het bijhouden van nummers. Het gaat over de vraag of u over acht jaar nog kunt aantonen welke versie bij welke machine hoorde, en dat het antwoord klopt.
Waarom handleiding_v3_definitief_NIEUW.pdf niet werkt
Vrijwel elke machinebouwer begint met een mappenstructuur op een netwerkschijf of in SharePoint. Dat is geen onzin: het is overzichtelijk, iedereen kan ermee werken, en voor het maken van documenten volstaat het.
Het probleem begint bij het aantoonbaar maken. Een bestand op een schijf heeft geen geschiedenis die standhoudt: het kan worden overschreven, de wijzigingsdatum verandert bij een kopie, en niemand ziet later wie welke versie heeft vrijgegeven. Bovendien vertelt de map niet aan welke machines een versie is meegegaan.
Drie dingen die versiebeheer moet vastleggen
Ten eerste: welke versies er zijn. Elke nieuwe uitgave krijgt een eigen plek in plaats van de vorige te overschrijven, met een versieaanduiding, de vrijgavedatum en een korte reden van de wijziging.
Ten tweede: wie hem heeft vrijgegeven. Dat is een handeling van een mens, niet een bestandseigenschap. Bij een incident is de vraag niet alleen welke versie er lag, maar wie hem heeft goedgekeurd.
Ten derde: bij welke machines die versie hoort. Dit is het stuk dat een mappenstructuur nooit oplost, en het is precies het stuk waar u later op wordt bevraagd.
Wat een vingerafdruk wel en niet bewijst
Van elke vrijgegeven versie wordt een SHA-256-vingerafdruk bewaard: een korte reeks die uniek is voor de exacte inhoud van dat bestand. Legt u die vingerafdruk vast met de datum en de naam van wie vrijgaf, dan kunt u later aantonen dat het bestand dat u toont hetzelfde bestand is als het bestand dat destijds is vrijgegeven.
Wees precies in wat dat betekent. Een vingerafdruk maakt een bestand niet onveranderbaar, en het is geen notariële vastlegging. Wat het doet, is elke wijziging zichtbaar maken: verandert er één teken in de PDF, dan komt de vingerafdruk niet meer overeen. In combinatie met versies die apart bewaard blijven, is dat voor een documentatiedossier een stevige onderbouwing.
Revisie na uitlevering: het lastigste geval
Stel dat u een veiligheidsrelevante verduidelijking doorvoert in de handleiding van een machine die al twee jaar bij een klant staat. Drie dingen moeten tegelijk waar blijven.
De nieuwe versie moet vindbaar zijn voor wie nu met de machine werkt. De oorspronkelijke uitleverset moet aantoonbaar blijven, want dat is wat u destijds hebt geleverd. En de eigenaar hoort erover geïnformeerd te worden.
Dat is geen mappenprobleem meer. Het vraagt dat de versie ernaast komt te staan in plaats van eroverheen, dat het paspoort van elke geleverde machine het onderscheid toont, en dat u de eigenaren van dat type in één handeling kunt aanschrijven.
Meertaligheid en versies door elkaar
Een handleiding in drie talen is niet één document met drie bestanden, maar drie documenten met elk hun eigen versiereeks. In de praktijk lopen die uit de pas: de Nederlandse versie is 2.2, de Duitse vertaling nog 2.1 omdat de vertaler nog bezig is.
Dat mag, zolang u weet wat er per exemplaar is vrijgegeven. Wat niet mag, is een machine naar Duitsland sturen terwijl de Duitse handleiding nog niet klaar is. Een controle op het land van levering vóórdat u vrijgeeft, voorkomt precies die fout.
Samen met SharePoint, niet in plaats van
Werkt uw technische afdeling in SharePoint, dan is er geen reden om dat te verlaten. Documenten worden daar gemaakt en goedgekeurd; dat is een ander proces dan uitleveren.
Een koppeling die wijzigingen als voorstel aanbiedt, werkt in de praktijk beter dan automatische publicatie. Iemand ziet dat er een nieuwe versie klaarstaat, controleert of die klaar is om naar klanten te gaan, en geeft hem dan vrij. Automatisch publiceren betekent dat een tussenversie bij een klant kan belanden.
Is een versienummer in de bestandsnaam niet genoeg?
Voor het maken van documenten meestal wel. Voor het aantoonbaar maken niet: een bestandsnaam zegt niets over wie de versie heeft vrijgegeven, wanneer, en bij welke machines hij is meegegaan.
Wat is een SHA-256-vingerafdruk?
Een korte reeks tekens die uniek is voor de exacte inhoud van een bestand. Verandert er iets in het bestand, dan verandert de reeks. Zo kunt u aantonen dat het document dat u nu toont hetzelfde is als het document dat destijds is vrijgegeven.
Moeten we oude versies bewaren?
Ja, als u wilt kunnen laten zien wat bij een eerder geleverde machine hoorde. De verordening vraagt dat documentatie beschikbaar blijft gedurende de verwachte levensduur van de machine en ten minste tien jaar; dat betreft de versie die bij die machine hoort, niet alleen de nieuwste.
Vervangt dit ons documentmanagementsysteem?
Nee. Uw DMS of SharePoint is waar documenten worden gemaakt en goedgekeurd. Machinepas legt vast welke goedgekeurde versie bij welke uitgeleverde machine hoort en houdt die beschikbaar.