Hoppa till innehållet

Projektportalen

Teknik

Hur projektportalen är byggd: varje del med ansvar, filer, kontrakt och det som återstår. Startsideportalen – prototypen av själva startsidan – har sin egen dokumentation i devportalen.

15 delar, alla dokumenterade.

Ytor

API:er

Dokumentationskontraktet

Samma kontrakt som i devportalen. En ny del av projektportalen är klar först när den har en post i katalogen och ett dok med alla obligatoriska fält – i samma commit som koden.

Tabell: Fält, Obligatoriskt, Krav
FältObligatorisktKrav
idJaSamma id som katalogposten. Finns ingen katalogpost skrivs den först – identiteten bor där, inte här.
sammanfattningJaEn mening om vad delen ansvarar för. Inte vad den innehåller, inte hur den är byggd.
ansvarJaTre till sex punkter. Varje punkt är något delen svarar för – och därmed något ingen annan ska göra.
filerJaVarje fil som bär funktionen, med en rad om vad den gör. Filkartan är det som gör doket användbart för någon som ska ändra.
apiNejExporterade funktioner och typer med signatur. Obligatoriskt så snart delen exporterar något som någon annan importerar.
kontraktNejDatakontrakt, manifestform eller turkontrakt – det andra måste följa. Obligatoriskt när delen ställer krav på sin omgivning.
beroendenJaKatalog-id på det delen bygger på. Tom lista är ett giltigt svar och betyder fristående.
beslutNejADR-nummer som styr delen. Utelämnas bara när inget beslut rör den.
kvarstarJaKänt som inte är gjort. Tom lista betyder färdig; ett utelämnat fält betyder att ingen har tänkt efter. Det är skillnaden.
uppdateradJaISO-datum. Sätts om varje gång delen ändras, i samma commit som ändringen.