Systemdokumentation: Funktioner, Formål og Indhold

Læs denne artikel for at lære om systemdokumentationen. Efter at have læst denne artikel vil du lære om: 1. Funktioner af effektiv systemdokumentation 2. Formål med systemdokumentation 3. Systemdokumentationens indhold 4. Niveauer af systemdokumentation.

Funktioner af effektiv systemdokumentation:

Effektiv systemdokumentation skal have følgende egenskaber:

1. Det skal tydeligt fremgå af det sprog, der let forstås.

2. Det bør være muligt at henvise til andre dokumenter.

3. Det skal indeholde alt, der er nødvendigt, så de, som læser det, omhyggeligt forstår systemet.

4. Det skal være tilgængeligt for dem, som det er beregnet til.

5. Når systemet bliver ændret, skal det være nemt at opdatere dokumentationen.

Formål med systemdokumentation:

Den formelle systemdokumentation opfylder følgende mål:

1. At give de nødvendige oplysninger til at udvikle uddannelsesprogrammer til operatører og brugere.

2. At skabe et køretøj med information for at bevise fremskridt i udviklingsprocessen og at overvåge processen.

3. At gøre konvertering af et system fra en maskine til en anden maskine nemmere.

4. At gøre systemændring og -implementering nemmere.

5. At mindske kommunikationsgabet mellem brugere, designere og ledelse.

6. At give et middel til forudfastsættelse af, hvad der vil ske, og hvornår.

Indholdet af systemdokumentation:

Rapporten om systemdesign skal indeholde følgende elementer:

1. En oversigt over hele projektet, der beskriver systemets generelle formål med de relevante oplysninger.

2. Dokumentation for hver input og output, der bruges i systemet. Hvert dokument skal ledsage hvert design og forklare formålet og brugen af ​​hver formular.

3. Dokumentation af hver fil i systemet, oprettelse og opdatering af sekvenser af filen skal være der.

4. System flowchart, der beskriver serien af ​​trin, der anvendes til behandling af data.

5. En finansiel analyse af de foreslåede og eksisterende systemer, der giver nuværende og fremtidige omkostninger med potentielle omkostningsbesparelser.

6. En beskrivelse af computersystemet og dets periferiudstyr.

Niveauer af systemdokumentation:

Niveauer af dokumentation betyder de personer eller stillinger i ledelseshierarkiet for hvem eller for hvilket dokument der er nyttigt til drift.

Disse niveauer er:

1. Dokumentation for brugere

2. Dokumentation for ledelse

3. Dokumentation for databehandlingsafdelingen.

1. Dokumentation for bruger:

For at systemet skal fungere korrekt, er det vigtigt, at brugerne forstår systemet fuldt ud, og er opmærksomme på, hvad der forventes af ham for at få det til at fungere korrekt.

1. Dokumentationen skal indeholde en prøve af hvert input dokument og instruktioner til brug af det.

2. Det skal også angive driftsplaner.

3. Brugerens dokumentation skal omfatte fillayout og filrelationsoplysninger.

4. Dokumentationen til brugeren skal i ikke-tekniske termer forklare alle aspekter af systemet fra brugerens synspunkt.

5. Det skal også forklare, hvordan systemet vil fungere, når det er fuldt installeret.

6. Den skal indeholde en stikprøve af hver outputrapport med den nødvendige forklaring.

7. Det skal angive kodeproceduren for inputdokumentet og også kodningsstrukturen for forskellige felter og relaterede tabeller.

8. Systembegrænsninger bør også fremhæves.

2. Dokumentation for ledelse:

Det omfatter systemforslag, der dækker følgende:

jeg. Funktionelle design-funktionelle krav.

ii. Krævede ressourcer.

iii. Cost benefit analyse.

iv. Udviklingsplan.

v. Begreber, arkitektonisk design.

3. Dokumentation for databehandlingsafdeling:

Dette er blevet opdelt i følgende tre kategorier:

(a) Dokumentation for systemets designere.

(b) Dokumentation for driftspersonale.

(c) Dokumentation for programmører.

(a) Dokumentation for systemets designere:

Det omfatter:

(i) Layout af masterfiler

(ii) Layouts af mellemfiler

(iii) Kontrol

iv) I / O-tidsplaner

(v) Output rapport layout

(vi) System flow diagram

vii) gennemførelsesplan

(viii) Kopi af programspecifikation

(ix) Indtastning fra layouts.

(b) Dokumentation for driftspersonale:

Dette har tre undergrupper:

1. Maskinoperationer - dette bør omfatte:

(i) Detaljerede instruktioner for hvert trin.

(ii) Arkiveringsplaner.

(iii) Afbryd / genstart procedurer.

(iv) JCL Listings for hvert trin.

(v) System flow.

2. Data forberedelser:

Dokumentationerne skal indeholde prøver af alle inputdokumenter, kortlayouter, rekordlayouter, specielt instrument til dataforberedelser, lagringsplaner for data.

3. I / O-kontrol:

(i) Kvalitetskontrolprocedurer for hvert trin.

(ii) Udsender (rapporter) detaljer

(iii) Behandlingsplaner

(iv) Oplysninger om dokumentkvittering.

c) Dokumentation for programmører:

For hvert program skal der være en programmappe, der dækker følgende:

(i) Kildeprogramoversigt.

(ii) Udvikling af system testkørsel.

(iii) Programspecifikationer I / O-layouter.

(iv) JCL notering.

(v) Anvendelse af enhver særlig teknik

(vi) Testresultater

(vii) Test data notering

(viii) Programlogisk flowchart.

(ix) Ændringer i specifikationer under program.

Slutdokumentet eller den endelige rapport skal være fagligt skrevet og bundet med klare illustrationer med begrænsede tekniske vilkår. Hvis øverste ledere af organisationen kan forstå begreberne i det nye system, vil de sandsynligvis vise påskønnelse og støtte fremtidige projekter.