Beoordelingscriteria PROJ3 CSD/AI

[CSD] Noodzakelijke voorwaarden aan code, documentatie e.d.

Met name relevant voor CSD-projecten, maar uiteraard ook van toepassing op AI-projecten waarbij code wordt aangeleverd.

Alle code wordt ter beoordeling aangeboden via Github of Gitlab en bovendien moet de 'commit history' een duidelijk beeld geven van het ontwikkelproces.

Code moet begrijpelijk zijn voor anderen, wat impliceert dat de structuur duidelijk moet zijn, met voldoende zinvolle comments de werking wordt toegelicht en dat het ondersteund wordt door technische documentatie zoals een ontwerp, class-diagrammen en systeemdiagrammen.

Slecht leesbare code, code zonder relevante comments, slecht gestructureerde code en code met niet-verklarende namen voor files, variabelen, classes en functies wordt niet geaccepteerd.

Geen 'uitgecommente' irrelevante code.

Code die niet gerelateerd lijkt aan het ontwerp en de documentatie wordt niet geaccepteerd. Uit de documentatie moet de werking van de code duidelijk zijn.

Documentatie moet duidelijk en volledig beschrijven wat de uitgangspunten zijn en de beoogde resultaten. Los daarvan wordt beschreven of die resultaten uiteindelijk behaald zijn.
Over de gehele periode is beschreven welke aanpak/methoden gebruikt zijn, welke experimenten gedaan zijn en wat hiervan de uitkomst was.
Gebruik bronvermelding voor alles wat je gebruikt van anderen! Voorkom plagiaat.
De documentatie bevat duidelijke conclusies en verslaglegging van de resultaten.
TIP: het is aan te raden wekelijks of -beter nog- dagelijks de documentatie te actualiseren.

[AI] Noodzakelijke voorwaarden aan experimenten, resultaten en documentatie

Resultaten moeten verifieerbaar zijn

Gebruikte frameworks, code en overige resources van anderen zijn expliciet genoemd en beschreven

Beoordelingscriteria

• Plannen zijn bij aanvang goedgekeurd door de docent

• Voortgang is op regelmatige basis gepresenteerd in de les en m.b.v. een (minimaal) wekelijks bijgewerkte online verantwoording (bv. blog). Aan het begin van het traject wordt een planning gemaakt die a.h.v. bevindingen regelmatig wordt bijgewerkt en zonodig bijgesteld.

• Het ontwerp of onderzoeksplan is als uitgangspunt genomen voor het eindresultaat. Je mag gaandeweg best tot nieuwe inzichten komen, maar verantwoord dan wel je keuzes.

• Robuustheid van het eindresultaat: de software/hardware mag niet crashen of onjuist werken als de gebruiker er verkeerd mee omgaat

• Bij zowel software als hardware: technische documentatie van een dergelijk niveau dat een derde in staat moet zijn het product opnieuw te maken. Dit impliceert dat het van voldoende niveau is voor debugging en verantwoording

• Klinkend resultaat of onderzoeksverslag met ondersteunende artefacten.

• Duidelijke gebruikers-interactie (indien van toepassing). Help de gebruiker bij het gebruik van het eindproduct.

Deliverables

• Eindpresentatie inclusief demo
• Werkend eindproduct of onderzoeks-tools
• Code (via git)
• Documentatie (upload in Orion)
• Onderzoeksverslag indien van toepassing
• Persoonlijke reflectie aan het eind van het project
  • Beleving
  • Proces / groepsproces
  • Wat heb je geleerd, wat ben je onderweg tegengekomen
  • Urenbesteding: hoeveel uur per week en de verdeling over de weken