Jag håller på med en större applikationsutveckling i mitt företag. Företaget äger jag själv och är 'ende anställde'.

Jag skulle vilja komma åt ett styrdokument, eller snarare beskrivning, av hur progamvaruutveckling bör dokumenteras och fastställas. Viss dokumentation kan ju göras i koden direkt, men knappas all. Annan dokumentation kan ju göras i vanlig ordbehandling, men inte all ... heller här.

Dokumentationen är främst till för egen del för att få struktur på arbetet och utvecklingen.

Någon som har något bra tips på hur detta skulle kunna gå till?

När du skall skapa ett program och vill göra en dokumentation av programmet kan du göra på detta sätt, finns givetvis fler:

När du skall skapa programmet, så har du givetvis fått din vision, en tanke om hur programmet skall se ut, efter att kunden gjort en beställning, din vision behandlar vad det skall göra, hur det skall göra osv. Försök få ned detta på ett papper, det kan vara i form av bara ren text, eller mixat med bilder, vilket det ofta är om det är ett program eller annan typ av produkt.

När du fått ned detta på ett papper, sätt dig ned med kunden och gå igenom det, se vad han har att tillföra, det kan vara en lite grejj som en annan färg på programmet eller något annat.

När ni både är nöjda så har du din specifikation, dvs det dokument som behandlar vad programmet skall utföra, vilket krav programmet har på sig osv.

Sen när det gäller dokumentationen i själva källkoden, skriv så att en annan programmerar förstår sig på detta, och du själv givetvis. Detta för att underlätta det framtida underhållet (uppdateringen) av programmet, kunden skiter i hur du har dokumenterat ditt program, så länge programmet tillfredställer det behov som kunden har.


Och eftersom programmet uppdateras, så uppdateras specifikationen, manualer osv.


Beskrivningen du söker kallas för KRAVspecifikation. Sök lite grann på internet så hittar du säkert något, på engelska heter det Software Requirements Specifikation förkortas SRS.

Har du andra funderingar?
Maila.

Prima!

Tack för hjälpen, jag ska genast ut på nätet och leta!