måndag 1 mars 2010

Förbättringsförslag 7: Informell dokumentation

Inom säkerhetskritisk mjukvaruutveckling är dokument en lika viktig leverabel som programmen. Vi har Subsystem Specification, Subsystem Technical Description, Software Requirements Specification, Software Detailed Description, Software Test Description, Subsystem Test Description för att nämna några. Inget av de här dokumenten är (primärt) till för att hjälpa utvecklaren att göra ett säkert system. De är till för att övertyga kund om att det är ett säkert system. Därför är dokumentation för programmerare lika sexigt som rapportskrivande för poliser.

Införs informell dokumentation där utvecklaren kan skriva ner sina tankar och skisser, buggar och arkitekturändringar, så kan detta vara underlag för den formella dokumentationen. Utvecklaren känner då ett mervärde i att dokumentera och risken för tankefel minskas.

Självklart är det utvecklarens ansvar att hålla reda på vad han gör för något men sparas inte denna informationen så försvinner den vid personalomsättningar och kvar finns bara en formell dokumentation som beskriver hur systemet fungerar, inte varför det gör det eller vilka luckor eller buggar som finns.

3 kommentarer:

Per sa...

hmm, lite av det som Anders nämner borde man lägga på kunden att specificera. I dag kan kund säga vi vill ha en funktion X men inte vad den skall användas till eller hur. I och med det, samt lite tidspress, blir våra funktioner ingenjörsmässiga och dokumentationen därefter.

Anonym sa...

men nu du åland...snöat in på jobb en del??
skoj då? det vill ju jag höra om!

Anders Holmberg sa...

Hej Jenna!
Jo men nu har en kollega spridit min blogg till massa chefer så jag kan inte hålla på och skriva om helgens fylleslag i Ronneby, eller att hultsfredsbiljetten är köpt sen länge :)

Hoppas allt är bra, du verkar riktigt glad på FB numera. Kramar!