"Dokumentationsprocessen ger upphov till den klassiska konflikten mellan att skapa
överblick och att dokumentera detaljer. Detaljer kan dränka överblicken.
En dokumentationsstandard gör det lättare att se till att dokumentationen blir
homogen"(Matthiassen, Munk-Madsen, Nielsen, Stage, 2001, sid 341).
Ovanstående citat beskriver betydelsen av en standard gentemot dokumentationen
kring ett systemutvecklingsprojekt. Standardens roll är alltså att framhäva en
tydlig konvention för att underlätta förståelsen kring innehållet.
Dokumentationen i ett systemutvecklingsprojekt spelar en central roll och tjänar olika
behov genom att styra arbetet, strukturera de inkrementella delresultaten i projektet
samt dokumentera övriga överrenskommelser om systemkrav och design. Dokumentationen
som sådan kan delas upp i två olika dokument:
* Analysdokument - En omfattande samt sammanhängande presentation av analysresultatet
* Designdokument - En omfattande samt sammanhängande presentation av designresultatet
Det är viktigt att man som utvecklare tillsammans med användaren i ett initierande läge
skapar ömsesidiga formaliteter kring de skriftliga överenskommelser som etableras.
Detta skall även vara som en grundval för den blivande kravspecifikiationen.
Designdokumentet skall å andra sidan upprätta en referensram som programmeraren kan
relatera till, och på så vis underlätta dennes arbete istället för att stagnera det
genom överflödigheter , istället bör designern
skapa förutsättningar för programmeraren genom en kort och precis dokumentation
som identifierar systemets komponenter och bestämmer dess struktur, funktionalitet samt
gränssnitt.
Språket i dokumentationen bör ligga på en perceptuell nivå för tolkaren. Tanken
är med andra ord inte att man skall förvirra läsaren med allt för abstrakt artikulerade
formuleringar, utan istället använda en terminologi som tilltalar bägge parters
verklighet. Detta kan ske med hjälp av symboler som diagram, figurer, tabeller, formler
och pseudokod. Kombinationen av dessa komponenter skulle mycket väl i samband med
ett renodlat språk kunna etablera en god dokumentation, förutsatt att den framhäver
sakinnehållet.
Sist men inte minst bör dokumentationen agera som ett "uppslagsverk" för bägge parter
i ett projekt för systemutveckling, detta delvis för att minimera konflikter mellan
parterna och på så vis vinna tid istället för att gå miste om den, då tiden anses vara
alltför värdefull i en sådan kontext.
//Amir
Inga kommentarer:
Skicka en kommentar