Vad kan arkitekturdokumentet innehålla?
- Det är populärt att dela in dokumentet i olika vyer.
Med vyer menas då helt enkelt olika avsnitt, där vart och
ett förklarar olika områden. Med områden menas inte
paket eller lager, tvärtom avhandlas hela programmet i varje vy.
Vanliga vyer är:
- Funktionalitet, förklarar vad användaren kan
göra med programmet.
- Logisk uppdelning, förklar till exempel hur programmet
är uppdelat i lager och vilka mönster som använts.
- Säkerhet, förklarar sådant som inloggning,
rättigheter, kryptering och loggning.
- Datalagring, förklarar databasens struktur och hur datat
översätts mellan databasen och programmet.
- Fysisk uppdelning, förklarar hur programmet är
uppdelat på olika datorer och processer.
- Implementation, beskriver programmets filer och hur dessa ska
hanteras av användaren.
- Det är förstås helt ok att strunta i vyer som
inte
behövs, och även att vid behov lägga till andra vyer.
- Hur förklaras programmet? En bra metod är
att
börja med att skriva löpande text och sedan
förtydliga texten med utdrag ur källkoden, uml-diagram,
bilder på användargränssnittet och andra bilder. Saknas löpande text är det inte
ett lättförstått dokument. Finns det inga bilder eller
kodutdrag som illustrerar texten är det knappast heller
lättförstått.