Hoppa till innehållet

Devportalen /portal/dev

Startsideportalens ekosystem för människa och agent

Devportalen

Dokumentationen

En sida per del av ekosystemet: vad den ansvarar för, var koden bor, vad den exporterar och vad som återstår. Identiteten – namn, status, källa – bor i katalogen och upprepas inte här.

Dokumentationskontraktet

En funktion är inte klar förrän den har ett dok som uppfyller det här. Listan är samtidigt granskningslistan: saknas ett obligatoriskt fält är dokumentationen inte färdig, och då är inte funktionen det heller.

Tabell: Fält, Krävs, Vad som gäller
FältKrävsVad som gäller
idAlltidSamma id som katalogposten. Finns ingen katalogpost skrivs den först – identiteten bor där, inte här.
sammanfattningAlltidEn mening om vad delen ansvarar för. Inte vad den innehåller, inte hur den är byggd.
ansvarAlltidTre till sex punkter. Varje punkt är något delen svarar för – och därmed något ingen annan ska göra.
filerAlltidVarje 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.
apiVillkoratExporterade funktioner och typer med signatur. Obligatoriskt så snart delen exporterar något som någon annan importerar.
kontraktVillkoratDatakontrakt, manifestform eller turkontrakt – det andra måste följa. Obligatoriskt när delen ställer krav på sin omgivning.
beroendenAlltidKatalog-id på det delen bygger på. Tom lista är ett giltigt svar och betyder fristående.
beslutVillkoratADR-nummer som styr delen. Utelämnas bara när inget beslut rör den.
kvarstarAlltidKä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.
uppdateradAlltidISO-datum. Sätts om varje gång delen ändras, i samma commit som ändringen.

Täckning

Varje katalogpost som inte är ett externt system ska ha ett dok. Listan nedan räknas fram ur katalogen och dokumentationen, så den kan inte bli inaktuell.

34 dokumenteradeInga luckor

Ingångar

Skalet och grunden

Modulerna

Server och bygge

Planerat