Modul 3 – Designa en OKF-bundle för din domän

Tillbaka till kursens startsida. Föregående modul: Modul 2 – OKF-specen i detalj.

Denna modul hjälper dig att mappa befintlig dokumentation – till exempel EA-artefakter, AI-förmågor eller runbooks – till OKF-koncept.

1. Föreslagen katalogstruktur

En bundle kan struktureras efter domän snarare än efter teknik. Några vanliga toppnivåkataloger:

  • domains/ – verksamhetsdomäner eller affärsområden.
  • capabilities/ – förmågor, kopplade till er förmågekarta.
  • patterns/ – återanvändbara arkitekturmönster.
  • playbooks/ – runbooks och driftinstruktioner för agenter.
domains/
├── index.md
├── capabilities/
│   ├── index.md
│   └── kundhantering.md
├── patterns/
│   ├── index.md
│   └── event-driven-integration.md
└── playbooks/
    ├── index.md
    └── incident_response.md

Koncept-ID:t härleds direkt från filens sökväg utan .md-ändelsen, till exempel ger tables/customers.md ID:t tables/customers och metrics/conversion_rate.md ID:t metrics/conversion_rate.

2. Domänspecifika type-värden och taggning

Fältet type är det enda obligatoriska i frontmatter, men det är er organisation som avgör vilka värden som är meningsfulla. Exempel för en arkitekturkontext:

  • type: capability – en verksamhetsförmåga.
  • type: pattern – ett arkitekturmönster.
  • type: playbook – en driftinstruktion.
  • type: metric – ett nyckeltal.

Kombinera med tags för att göra koncepten sökbara tvärs domäner, till exempel tags: [gt, ekonomi, integration].

3. Konformans, versionering och governance

Eftersom bundlen ligger i ett Git-repo kan ni återanvända befintliga Git-flöden för att styra ändringar:

  • Skapa en branch per ändring av bundlen, precis som för kod.
  • Öppna en pull request så att ändringar i koncept-filer granskas

av en kollega innan de mergas.

  • Låt CI (se Modul 4) blockera merge om type

saknas eller om YAML inte går att parsa.

  • Använd log.md i varje delkatalog för att dokumentera

kronologiska ändringar, så att både människor och agenter kan 

  följa historiken.

Flera skribenter beskriver OKF just som en portabel markdown-standard för agent-kontext – se till exempel genomgången hos Suganthan om OKF och artikeln "What is Open Knowledge Format?" på Medium.

Nästa steg: gå vidare till Modul 4 – Verktyg, agenter och automation.