CalZoneVUB / Documents

Bevat de te opleveren documenten, alsook user manuals etc. (Geen documentatie van de code.)
0 stars 2 forks source link

SDD: Feedback na iteratie 3 #87

Open MPieter opened 10 years ago

MPieter commented 10 years ago

De feedback van iteratie 3 op het SDD-document moet verwerkt worden. Hieronder nog eens de commentaren van Ragnhild:

Sectie 3 "Naarmate de ontwikkelingen [...] derde iteratie." Vergeet niet tekst aan te passen voor laatste iteratie. (Geldt voor gehele document [vb. 3.1 "In deze iteratie..."])

Sectie 3.1 "categoriën" => categorieën Fig 3.x Inconsistent gebruik hoofdletters/kleine letters storend Fig 3.1 "standard schedules": is niet duidelijk wat hiermee bedoeld wordt

Sectie 3.2.x De structuur van de beschrijvingen is verwarrend: lagen (bv. 3.2.2) en componenten (bv. 3.2.4, 3.2.6) worden door elkaar vermeld. Gebruik misschien een onderverdeling per laag?

Sectie 3.2.2 "Het is een verbeterde uitbreiding aan" Onnauwkeurig verwoord. Waarschijnlijk wordt hier bedoeld dat het abstractieniveau t.o.v. data-laag stijgt in de service-laag.

Sectie 3.2.5 Te vaag, geef een beetje meer uitleg. Wat is business logic?

Sectie 3.4.2 "Voor het in productie gaan van de applicatie is het sterk aangeraden de debug logs uit te schakelen daar het genereren van logs het systeem kan vertragen." De hoofdreden om DEBUG uit te schakelen is niet zozeer voor de snelheid (geoptimaliseerd in meeste application-servers), maar om de grootte van de logs te beperken en de inspectie te vereenvoudigen. De voorgestelde oplossing (log file voor >=INFO, en aparte log file voor =DEBUG) is eentje die waarschijnlijk niet zoveel zal worden toegepast: het is voor developers moeilijker om een enkele trace te reconstrueren uit meerdere logfiles.

Sectie 3.4.3-3.5.1 Het is niet duidelijk wat de interface is met OptaPlanner. Welke klassen/datastructuren zijn van CalZone, welke van OptaPlanner? Maak hier een duidelijk onderscheid tussen (i) in de tekst, (ii) met annotaties/kleurcodes in schema.

Sectie 3.5.1 Kan je zeggen welke de harde constraints zijn en welke de softe? Bv. "Leraren mogen/kunnen geen 2 verschillende lessen op eenzelfde tijdstip geven." is waarschijnlijk een hard constraint, terwijl "Een student heeft maximaal X uur les op een dag." een softe constraint is. Voor "Er worden geen 2 lessen/sessies van hetzelfde vak achter elkaar geboekt." is het niet duidelijk.

MPieter commented 10 years ago

@yocoppen Ter herinnering voor het SDD van Youri.

endymion64 commented 10 years ago

Ik zal er mij vandaag tussen de repetities door op storten

endymion64 commented 10 years ago

Done