TDDC76 Programmering och datastrukturer

Designdokument

Följande bör finnas med i det mycket förenklade designdokument som varje projektgrupp ska lämna in.

• Försättssida

  Projektets namn används som huvudrubrik. Underrubrik som anger att det är ett analysdokument (ev. versionsnummer som underrubrik till denna). Vidare namnen på projektgruppens medlemmar, datum och år.

• Innehållsförteckning

• Klassdiagram

  Ett eller flera klassdiagram som ger en övergripande bild av de klasser som ingår i systemet och hur de är relaterade. Detta kan vara samma diagram som finns i analysdokumentet eller modifierade diagram, om det under designen framkommit saker som påkallat förändringar.

• Klassbeskrivningar

  Förfinade klassbeskrivningar i jämförelse med de i analysdokumentet. Kan omfatta det mesta som är av intresse för vad som ska bli en klassdefinition i språket (C++): klassnamn, basklass(er) om klassen är en subklass, konstruktorer, övriga medlemsfunktioner (namn, returtyp, parametrars namn och typ), datamedlemmar (namn och typ). Normalt inget om detaljimplementering av metoder ska beskrivas. Kan vara beskrivningar som är eller motsvarar s.k. klassbeskrivningsformulär.

  Utökad textuell beskrivning jämför med analysdokumentet med mer detaljer.

  Klassbeskrivningarna kan gruppers enligt de delsystem som eventuellt finns, t.ex. klasser som hör till användargränsytan beskrivs för sig, osv.

• Annat

  Om data ska lagras på filer kan filformat och annat som rör filhanteringen beskrivas.

  Om t.ex. kommunikation ska ske över nätverk kan nätverksprotokoll beskrivas.

  Om en grafiskt användargränsyta ska användas kan figurer som visar hur fönster, etc. är tänkt att se ut finnas med.

Sidansvarig: Jonas Lindgren
Senast uppdaterad: 2015-08-18