Dokumentation som ger dig bättre nattsömn

Med en väldokumenterad SiteVision-webbplats får du en helt annan ro på jobbet

Den här artikeln handlar om varför du bör ta fram en övergripande dokumentation över din webbplats och kontinuerligt hålla den uppdaterad. Det tar bara några timmar att komma igång och sedan har du ett ypperligt stöd för att förvalta och vidareutveckla webbplatsen i framtiden.

Varför behöver jag dokumentera?

Anledningarna är många men framförallt är det för att få en bra översikt och kontroll över webbplatsen. Har man en komplicerad webbplats med många specialanpassningar och integrationer ökar behovet och vice versa. Använder man flera olika leverantörer ökar också behovet.

När en ny funktion precis är installerad har man koll på den och förtränger dokumentationsbehovet, men när man efter en tid ska dra sig till minnes en funktion bland tio-femton andra är det alltid svårare. Vem utvecklade funktionen? Vilka filer hör ihop med den? Finns det en manual eller lathund någonstans?

Syftet med dokumentationen är att ge en överblick över de komplexa delarna på en webbplats och att sammanställa övergripande information som är bra att ha lätt till hands om något går snett. Överblicken är en stor fördel att ha som underlag till leverantörer när webbplatsen ska byggas om i framtiden. Den kan också hjälpa till om man är osäker på om man kan ta bort en viss fil eller inte.

Vilka delar ska man dokumentera på en SiteVisionwebb?

I första hand bör man dokumentera lösningar som inte bygger på standardfunktionalitet och inte fungerar på normalt “SiteVisionsätt” samt funktioner som är beroende av och/eller sammankopplade med inlänkade filer/system. Man bör även prioritera verksamhetskritiska funktioner som krismeddelanden och krismallar.

Vad ska man dokumentera?

Här kan man lägga sig på lite olika nivåer men här kommer förslag på saker som är bra att få med.

Specialfunktioner som finns på webbplatsen

  • Leverantör av funktionen med kontaktuppgifter
  • Intern ansvarig/beställare
  • Utvecklad när? Ändrad när?
  • Var på webbplatsen ligger funktionen?
  • Beroenden (JavaScript-, CSS-filer och annat som funktionen använder)
  • Hänvisning till manual/lathund
  • Övriga tips/trix/felsökningshjälp

System som finns integrerade i webbplatsen

  • Leverantör av källsystemet med kontaktuppgifter
  • Leverantör av integrationsjobbet med kontaktuppgifter (om annan än ovan)
  • Internt ansvarig/beställare
  • Integrationsmetod (portlet/proxy/iframe/RSS etc)
  • Länk till källsystem
  • Hänvisning till manual/lathund
  • Övriga tips/trix/felsökningshjälp

Att ha med en länk till källsystemet för dina integrationer ger dig möjlighet att enkelt kolla om källsystemet är uppe och fungerar rätt ifall integrationen slutar fungera. Om källsystemet är nere eller inte fungerar som det ska är det leverantören av detta man kontaktar istället för den som gjort integrationen.

Det är nyttigt att ha ett sätt för att samla manualer, lathundar och andra instruktioner på ett strukturerat sätt. Funktioner som inte används dagligen är extra viktiga att dokumentera.

Så kommer du igång direkt

  • Skapa ett dokument och sätt upp ramarna, gärna utifrån punkterna här ovanför.
  • Låt gärna dokumentationen vara en ickepublik gren av webbplatsen så har du den alltid nära till hands.
  • Om du inte har tid att dokumentera hela webbplatsen på en gång, ta lite i taget.

Kom ihåg att hålla manualen uppdaterad allt eftersom webbplatsen förändras.

Författa lugnt!

Jönköping

Jönköping

Limepark AB

Gjuterigatan 9
553 18 Jönköping
Vägbeskrivning

Stockholm

Stockholm

Limepark AB

Gotlandsgatan 46
116 65 Stockholm
Vägbeskrivning

Timrå

Timrå

Limepark AB

Folketshusvägen 10
860 35 Söråker
Vägbeskrivning

Örebro

Örebro

Limepark AB

Kansligatan 1
703 61 Örebro
Vägbeskrivning

Örnsköldsvik

Örnsköldsvik

Limepark AB

Magasinsallén 2
891 31 Örnsköldsvik
Vägbeskrivning

*

I supporten:
Evylyn
AAA - Högsta kreditvärdighet