Gå til innhold

[Løst]Dokumentasjon av systemet på driftsavdeling.


Anbefalte innlegg

Hei! Jeg jobber på en driftsavdeling hvor vi har ansvar for en ca 30 servere og 300 brukere. Dokumentasjon er et området hvor vi (og jeg tipper mange andre) kan bli mye bedre.

 

I dag blir mye av dokumentasjonen laget i MS Word. Det er jo relativt greit, men har mange ulemper som blandt annet:

- Ikke mulighet for revisjoner (?).

- Filnavn som "emne".

- Vanskelig å søke.

- Får ikke automatisk beskjed (f.eks RSS-feed) på nye eller endrede innlegg.

- Tungt å lese mot f.eks en WEBside.

 

Jeg har prøvd mange forskjellige systemer, og legger ved en veldig kort erfaring med disse.

Wordpress:

Veldig bra hvis du kun ønsker å rable ned dokumentasjon. Da blir det hvertfall skrevet ned et sted. Søking går også fort. Trenger ikke å tenke på kategorier, bare legg til den taggen du føler er riktig. Støtte for RSS.

 

Drupal:

Denne tror jeg kanskje jeg ender opp med til slutt. Taxonomy er utrolig fleksibelt og du kan lage en fantastisk webside enkelt og greit. Har ikke testet LDAP-autentisering ennå, men tror dette går bra. Har mange muligheter i menystruktur, tags, RSS-feeds og generelt store muligheter for å organisere dokumentasjon bra.

Minus når man skal legge ved bilder, kan oppfattes som klønete.

Eneste som gjør at jeg ikke bruker dette nå, er fordi jeg ikke får til noen form for Autosave underveis når man skriver. Har prøvd to moduler, autosave og draft, men de fungerer ikke som de burde/skal. Skal gi denne et lite forsøk til litt senere, men er ganske langt nede i kjelleren da "det alltid er noe"

En annen setback med Drupal, som kanskje er den viktigste, er at HVIS vi går over til et annet system er det etter hva jeg forstår veldig klønete å eksportere artiklene.

 

DokuWiki:

Var rask innom dette systemet. Men tilbakemelding og egne erfaringer følte dette var mer tungvindt en det trengte å være, i tillegg til at det fort ble mye rot. (Tror ikke en side i DokuWiki som heter ServerNavn er den samme siden som heter servernavn (med små bokstaver)).

 

 

Så, hva er det jeg ønsker å dokumentere, hva slags krav setter jeg til systemet?

Dette må dokumenters som et minimum:

- Servere

- Nettverk

- Feilmeldinger

- Rutiner

- (og kanskje en FAQ til brukerene?)

 

Noen krav jeg setter til "CMSen":

- Flerbruker (se hvem som skriver hva).

- Tilgangskontroll (kan i værste fall gjøres på IP)

- Lett å organisere dokumentet H1, H2, plassering av bilder, linker osv.

- Lett å legge til bilder. (Screenshots)

- Lett å oppdatere.

- Feeds på nye og endrede dokumenter.

- Lett å linke til andre filer/kataloger (Visio, Excel, osv).

- Autosave hvert 10ende minutt. (da det fort blir store dokumenter man arbeider med)

 

Hva jeg ønsker med denne tråden:

At dere kommer med erfaringer og meninger rundt dokumentasjon av nettverk og alt som hører med på en mellomstor driftsavdeling. Hva slags systemer dere bruker i dag, og hva dere kunne tenke dere i fremtiden.

 

Takker for alle svar!

Lenke til kommentar
Videoannonse
Annonse

Du kan få versjonskontroll på word-dokumenter dersom du putter det f.eks inn i CVS eller Subversion.

 

Wordpress er uten tvil helt feil verktøy.

 

Vi har igrunn en filstruktur til dokumentasjon med Excel og Word-dokumenter. Langt ifra en optimal måte å gjøre det på, men det er så enkelt at alle kan gjøre oppdateringer på dokumentasjonen. Det dummeste du gjør er å innføre noe som ikke er såpass enkelt at alle klarer å oppdatere dokumentasjonen. En ikke-oppdatert dokumentasjon er ofte verre enn ingen dokumentasjon.

 

En veldig viktig feature som folk ofte glemmer å tenke over er mulighet for offline tilgang til dokumentasjonen. Hva hvis filservern deres tryner, hvordan får dere da tilgang til dokumentasjonen som skal hjelpe dere i feilsøking og håndtering av problemet. Det samme hvis du har off-site lokasjoner som du reiser ut til. Nå ser jeg dog utifra brukermasse at dere drifter et ganske lite nettverk og har kanskje ikke så utrolig mye dokumentasjon liggende at dere ofte klarer dere med ting dere husker.

 

Angående offline-muligheten bør dere også tenke om dere har noen "kriserutiner" osv. Sånt er igjen kanskje vanlig hvis man har off-site lokasjoner. Hvem må varsles ved strømbrudd/kommunikasjonsbrudd osv. Noen deler av dokumentasjonen er alltid greit å ha i papirform, så dokumentasjonssystemet bør hvertfall ha mulighet til å få ut data i en nogen lunde lesbar form.

Lenke til kommentar
  • 3 uker senere...

Hei!

 

Da falt valget på DokuWiki. Det bruker ikke databaser, kun en enkelt filstruktur, med kataloger.

 

Enkelt å organisere, flytte og koble dokumenter opp mot hverandre. Enkelt å ta backup av. Enkelt å ha offline versjon. Støtter plugins, osv osv.

 

Legger ikke mer i tid i denne posten hvis ingen lurer på noe.

 

Forøvrig: Den eneste pluginen jeg har funnet bruk for heter "pagemove", og gir muligheten til å flytte på sider en kategoriserer feil, uten å bryte linker.

 

Takk :)

Lenke til kommentar

Opprett en konto eller logg inn for å kommentere

Du må være et medlem for å kunne skrive en kommentar

Opprett konto

Det er enkelt å melde seg inn for å starte en ny konto!

Start en konto

Logg inn

Har du allerede en konto? Logg inn her.

Logg inn nå
×
×
  • Opprett ny...