Avsnittet Logisk uppdelning
- Avsnittet ska förklara
programmets arkitektur och design.
- Förklara vilka lager som finns.
- Rita ett interaktionsdiagram (dvs sekvens- eller
kommunikationsdigram) som går genom alla lager. Kom ihåg
att
förklara det! Ta inte med interaktionsdiagram för all
funktionalitet,
bara tillräckligt mycket för att förklara hur de olika
lagren är
uppbyggda och hur de kommunicerar med varandra.
- Om det finns någon del av designen som är speciellt
klurig kan den förklaras med text och interkationsdiagram i ett
eget delavsnitt.
- Det kan vara en bra idé att ta med utdrag ur koden,
antingen i stället för interaktionsdiagram eller tillsammans
med dem. Välj i så fall noga ut vilka kodavsnitt som ska
vara med, inga långa koddumpar. Det kan också vara bra att
rensa upp lite i koden och bara visa det viktigaste. Till exempel kan
undantagshantering tas bort. Ange i så fall i texten att koden
inte är komplett. Kod ska den placeras i en figur med figurtext,
tydligt avskilld från resten av texten.
- Ange viktiga mönster som använts.
- Ta med domänmodellen om du anser att den förtydligar.
Kom
ihåg att den i så fall ska förklaras också, visa
aldrig en bild
utan förklarande text.
- Förklara hur det är tänkt att ny funktionalitet
ska läggas till. Syftet med det är att designen inte ska
förstöras i framtiden när någon annan utvecklare
lägger till funktionalitet. Ta gärna med ett exempel där
ny funktionalitet läggs till.
- Antag att läsaren har ungefär samma kunskaper som du
själv, men inte vet något om programmet i fråga. Det
är alltså inte nödvändigt att, mer än
möjligtvis ytterst kortfattat, förklara välkända
mönster som tex controller. Fråga dig själv vad du
skulle behöva få reda på för att
förstå programmet så bra att du skulle kunna ta
över underhållet av det.