Ga naar hoofdinhoud

ADR

Deze sectie bevat Architectural Decision Records (ADR) voor het Docusaurus root-project aim-ene.github.io.

Overzicht​

De ADR's geven extra achtergrond voor docenten en ontwikkelaars van het lesmateriaal over technische keuzes rondom Docusaurus voor deze websites. Voor studenten kunnen de ADR's ook als voorbeeld dienen. In SOEX (week 1 les 4) behandelen we ADR's expliciet, en daarna maak en gebruik je ze zelf en ook in het eind projectwerk (PeXe). Dit project is alleen front-end en wijkt daarmee af van de SoEx en PeXe projecten, die vaker full stack zijn. ADR's zijn een laagdrempelige opstap naar beter ontwerpdenken in teams: "a gateway to better design thinking" (Keeling & Runde, z.d.).

Alle ADR's in deze sectie volgen primair het ADR template van Michael Nygard (2011). In deze repo gebruiken we daarnaast expliciet een sectie Options, zodat alternatieven snel scanbaar blijven.

We laten na ook een ADR op te nemen over de keuze voor dit ADR template zelf; maar mits je het consistent doet kun je zelf anderen gebruiken. Als voorbeeld van en alternatief/optie kun je ook een Y-statement gebruiken, zoals beschreven door Doc Soc (z.d.), bijvoorbeeld:

In de context van het publiceren van lesmateriaal voor Software Engineering vakken aan de HAN Academie voor ICT en Media, 'facing' de keuze voor een ADR template, 'we decided on' Nygard tenplate om aan te sluiten bij deze algemene standaard, and neglected een alternatief als Y-statements uitsluiten, waarmee we accepteren dat de ADR's wat langer zijn en meer verbose.

Merk ook op dat we hierbij kiezen voor ADR's in het Nederlands, maar handhaven van de Engelse kopjes en/of af en toe Engelse woorden. Hiermee krijgen we een soort hybride taal, die developers wel kennen van conventies in code als student1.getSBer(), waarbij de Java keywords en conventies wel Engels zijn (zoals de Java Beans standaard; GeeksforGeeks, z.d.), maar de domeintermen Nederlands, omdat het nu eenmaal een Nederlands domein is (met Nederlandstalige gebruikers, wetgeving en achtergronddocumenten).

Bronnen​