1 / 23

Statisk dokumentasjon

Statisk dokumentasjon. TDT4285 Planlegging og drift av IT-systemer Anders Christensen, IDI. Hva er dokumentasjon?. Forklaring av systemet? Blueprint for systemet? Infrastruktur for komm. mellom sysadmins? Byråkratisk herk og evig stilskriving?. System. Implementerer. Forklarer. Dok.

orrick
Télécharger la présentation

Statisk dokumentasjon

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Statisk dokumentasjon TDT4285 Planlegging og drift av IT-systemer Anders Christensen, IDI TDT4285 Planl&drift av IT-syst

  2. Hva er dokumentasjon? • Forklaring av systemet? • Blueprint for systemet? • Infrastruktur for komm. mellom sysadmins? • Byråkratisk herk og evig stilskriving? System Implementerer Forklarer Dok TDT4285 Planl&drift av IT-syst

  3. Målsetting • Formidle kunnskap mellom sysadmins (kommunikasjon) • Sette et utgangspunkt for systemet (endringshåndtering) • Felles referansepunkt for samarbeid (skalering) TDT4285 Planl&drift av IT-syst

  4. Dokumentasjonsfeller • Read-write-forhold. • At alle dokumenterer på hvert sitt vis • Dårlig dok blir ansvarsfraskriving • Å tro at ”dette husker vi, dere ...” • Å dokumentere uten en bruksplan • Å skrive dokumentasjonen etterpå. TDT4285 Planl&drift av IT-syst

  5. Dimensjoner å måle dok etter • Endringsrate (ggr pr tidsenhet) • Endringsvolum (% pr endring) • Lokalitet (% lokal info) • Spesifiserthet (rutineliste vs oversikt) • Brukshyppighet (daglig vs aldri) • Automatiseringgrad (manuell vs auto) • Omfang (alt vs sporadiske områder) TDT4285 Planl&drift av IT-syst

  6. Fordelaktig Høy lokalitet Lavt volum Lav endringsrate Indireksjon av hyppige endringer Ufordelaktig Generaliseringer utover lokal fokus Manglende struktur Monotolittisk Ikke tilpasset lesers kompetansenivå Sammenhenger TDT4285 Planl&drift av IT-syst

  7. Hva kjennertegner god dok? • Forventninger til format • Forventninger til plassering • Forventninger til fokus • Forventninger til innhold • Forventninger til tilgjengelighet • Forventninger til oppdaterthet TDT4285 Planl&drift av IT-syst

  8. Tommelfingerregler for dok • Skap en struktur • Jevnlige reviews og audits • Skap tilgjengelighet • La dok være en del av ”loop’en” • Oppdater! (helst før endring) • Eliminer det som ikke vil bli brukt eller oppdatert. TDT4285 Planl&drift av IT-syst

  9. Andre tips ... • Visualiser en målgruppe når du skriver • Ha peer review på all dok • Bruk maler og sjablonger • La en disposisjon først TDT4285 Planl&drift av IT-syst

  10. Dok-typer:Systemdokumentasjon Format: manualer Innhold: referansedokumentasjon Når: for alle leverte systemer Fare: for mye og for generelt Skriver: leverandør Bruker: alle TDT4285 Planl&drift av IT-syst

  11. Dok-typer:Brukerdokumentasjon Format: how-tos, FAQ og guider Innhold: hvordan få ting til Når: for alle tjenester som er levert Fare: rett fokus, nivå og vanskelighetsgrad Skriver: alle Bruker: brukerne TDT4285 Planl&drift av IT-syst

  12. Dok-typerSystembeskrivelse Format: tekstlig Innhold: overordnet beskrivelse Når: felles for hele systemet Fare: gjentaking av info fra subdok. Skriver: 3.linje Bruker: alle TDT4285 Planl&drift av IT-syst

  13. Dok-typerSystemoversikt Format: diagram, skisser, tabeller Innhold: lokal referanseinformasjon Når: for alle delsystemer Fare: manuell oppdatering Skriver: automatisert av 3.linje Bruker: alle TDT4285 Planl&drift av IT-syst

  14. Dok-type:Subsystembeskrivelse Format: tekstdokument Innhold: gjennomgang av alt for et subsys Når: ett dokument for hvert subsys Fare: gjenfortelling av systemdok Skriver: 3.linje Bruker: fortrinnsvis 3. og 2.linje TDT4285 Planl&drift av IT-syst

  15. Dok-type:Standard operasjonsrutine Format: trinnvis liste Innhold: fremgangsmåte/prosedyre Når: alle rutineoppgaver Fare: forsøke å håndtere for mange feil Skriver: 3.linje Bruker: 1.linje TDT4285 Planl&drift av IT-syst

  16. Dok-type:Test-rutine Format: skrittvis prosedyre med fasit Innhold: testing av funksjonalitet Når: alt som kan slutte å virke Fare: vag fasit eller for omfattende Skriver: 3.linje Bruker: 1.linje og all feilsøking TDT4285 Planl&drift av IT-syst

  17. Dok-type:HW-logg Format: historisk dagbok, loggføring Innhold: løpende info om endringer Når: hver gang noe hw-messig skjer Fare: for detaljert nivå Skriver: alle, spesielt 1. og 2.linje Bruker: alle TDT4285 Planl&drift av IT-syst

  18. Dok-type:Kommentarer i konfig-filer/prog Format: innbakt som kommentarer Innhold: overordnede forklaringer Når: ved endring av standardverdier Fare: platte selvfølgeligheter Skriver: fortrinnsvis 2. og 3.linje Bruker: alle TDT4285 Planl&drift av IT-syst

  19. Dok-type:Hjernemessig ’coredump’ Format: oppramsing i fritt format Innhold: alt som en person kan om noe. Når: ved liten tid Fare: ikke top-down og bredde-først Skriver: hvem-som-helst Bruker: hvem-som-helst TDT4285 Planl&drift av IT-syst

  20. Sammenheng mellom dok-typer Systembeskrivelse Systemoversikt HW- logg Subsystembeskrivelse SOP Testrutiner Systemdokumentasjon TDT4285 Planl&drift av IT-syst

  21. Rammer for dokumentasjon • En ferdighet som må læres, så sørg for trening for de ansatte. • Skap belønning for å arbeide med systemet og skrive god dok. • Arbeid aktivt med å endrevanene til de som ikke dokumenterer • Lag revisjonsplan for dok TDT4285 Planl&drift av IT-syst

  22. Sideeffekter av dokumentering • Lettere å dokumentere et godt enn et stort og kaotisk system. • Vanskeligere å anta – må sjekke • Senker hastigheten i arbeidet :-) • Lettere for flere å arbeide sammen • Muliggjør audit og review TDT4285 Planl&drift av IT-syst

  23. Dok er nødvendig for å: • Anonymisere arbeidsoppgaver • Muliggjøre peer review • Spesifisere en normaltilstand • Identifisere forbedringsområder • Angir basis for endringer. TDT4285 Planl&drift av IT-syst

More Related