Dokumentation för våra kockar

När en webblösning överlämnats till slutleverans finns det alltid med en dokumentation som beskriver hur den byggts. Man kan likna det vid ett matlagningsrecept som nästa kock ska kunna läsa för att återskapa samma måltid.

Dokumentation från redan skapade lösningar

Socialstyrelsen har sedan en tid tillbaka redan skapat ett par sajter/tjänster i Drupal, exempelvis för den nyligen lanserade Behörigheter.

Värdet av dokumentation

Dokumentationen är praktiskt för oss i webbprojektet eftersom den beskriver lösningen på flera plan, så att både vi internt och tredje part kan bygga ut och integrera mot lösningarna.

Innehåll i dokumentationen

Vad som ska ingå i dokumentationen kan variera efter behov, men dessa rubriker brukar vara med:

  • Ramverk (Kodstandard, struktur)
  • Driftsmiljö/Serverarkitektur
  • Systemkrav
  • Installation/Konfiguration
  • Funktioner (syften och implementation)
  • Processer/flöden
  • Användarflöden/interaktioner

Behov av lösningsarkitekt

Den uppsättning lösningar som redan finns behöver nu gås igenom och analyseras så att de hänger ihop, fungerar tillsammans och följer en gemensam standard.

Eftersom vi kommer att lämna Sharepoint, behöver vi också skapa en strategi och tidplan för migrering av lösningarna där.

Detta innebär att vi behöver en lösningsarkitekt som kan ta helhetsansvar för alla lösningar och gå igenom dokumentationen för dem.

Kommentera

E-postadressen publiceras inte. Obligatoriska fält är märkta *