Systemdokumentasjon: Funksjoner, Formål og Innhold

Les denne artikkelen for å lære om systemdokumentasjonen. Etter å ha lest denne artikkelen vil du lære om: 1. Funksjoner for effektiv systemdokumentasjon 2. Formål med systemdokumentasjon 3. Innhold i systemdokumentasjon 4. Nivåer av systemdokumentasjon.

Funksjoner for effektiv systemdokumentasjon:

Effektiv systemdokumentasjon skal ha følgende egenskaper:

1. Det må tydelig fremgå på språket som lett forstås.

2. Det bør være mulig å referere til andre dokumenter.

3. Det skal inneholde alt som trengs, slik at de som leser det, nøye forstår systemet.

4. Det skal være tilgjengelig for de som det er ment for.

5. Når systemet blir modifisert, bør det være enkelt å oppdatere dokumentasjonen.

Formål med systemdokumentasjon:

Den formelle systemdokumentasjonen oppfyller følgende mål:

1. Å gi nødvendig informasjon til å utvikle treningsprogram for operatører og brukere.

2. Å skape et kjøretøy med informasjon for å bevise fremgang i utviklingsprosessen og å overvåke prosessen.

3. For å gjøre konverteringen av et system fra en maskin til en annen maskin enklere.

4. For å gjøre systemendring og -implementering enklere.

5. For å begrense kommunikasjonsgapene mellom brukere, designere og ledelse.

6. Å gi et middel til å bestemme på forhånd hva som vil skje og når.

Innhold i systemdokumentasjon:

Rapporten om systemdesign skal inneholde følgende elementer:

1. En oversikt over hele prosjektet som beskriver den generelle hensikten med systemet med relevant informasjon.

2. Dokumentasjon for hver inngang og utgang som brukes i systemet. Hvert dokument skal følge hvert design og forklare formålet og bruken av hver formular.

3. Dokumentasjon av hver fil i systemet, oppretting og oppdatering av sekvenser av filen, bør være der.

4. System flytskjema som beskriver serien av trinn som brukes i behandling av data.

5. En finansiell analyse av de foreslåtte og eksisterende systemene, som gir nåværende og fremtidige kostnader med potensielle kostnadsbesparelser.

6. En beskrivelse av datasystemet og dets periferiutstyr.

Nivåer av systemdokumentasjon:

Nivåer av dokumentasjon betyr personer eller stillinger i ledelseshierarkiet for hvem eller til hvilket dokument som er nyttig for operasjonelle formål.

Disse nivåene er:

1. Dokumentasjon for brukere

2. Dokumentasjon for ledelse

3. Dokumentasjon for databehandlingsavdelingen.

1. Dokumentasjon for bruker:

For en jevn drift av systemet er det viktig at brukerne forstår systemet fullt ut, og er klar over hva som forventes av ham for å få det til å fungere vellykket.

1. Dokumentasjonen skal inneholde en prøve av hvert inngangsdokument og instruksjoner for bruk av det.

2. Det skal også angi driftsplaner.

3. Brukerens dokumentasjon skal dekke filoppsett og filrelasjonsdetaljer.

4. Dokumentasjonen til brukeren bør i ikke-tekniske forklaringer forklare alle aspekter av systemet fra brukerens synspunkt.

5. Det skal også forklare hvordan systemet skal fungere når det er fullt installert.

6. Det bør inkludere et utvalg av hver utgangsrapport med nødvendig forklaring.

7. Det skal angi inngangsdokumentets kodingsprosedyre, og også kodingsstrukturen for ulike felt og tilhørende tabeller.

8. Begrensninger av systemet bør også utheves.

2. Dokumentasjon for ledelse:

Det inkluderer systemforslag som dekker følgende:

Jeg. Funksjonelle design-funksjonelle krav.

ii. Ressurser kreves.

iii. Kostnadsfordeler analyse.

iv. Utviklingsskjema.

v. Begrep, arkitektonisk utforming.

3. Dokumentasjon for databehandlingsavdeling:

Dette har blitt delt inn i følgende tre kategorier:

(a) Dokumentasjon for systemets designere.

(b) Dokumentasjon for operasjonell personell.

(c) Dokumentasjon for programmerere.

(a) Dokumentasjon for systemets designere:

Det inkluderer:

(i) Layout av hovedfiler

(ii) Layout av mellomfiler

(iii) Kontroller

(iv) I / O-tidsplaner

(v) Output rapport layout

(vi) System flytskjema

(vii) Implementeringsplan

(viii) Kopi av programspesifikasjon

(ix) Inndata fra layouter.

(b) Dokumentasjon for operasjonell personell:

Dette har tre undergrupper:

1. Maskinoperasjoner - dette bør omfatte:

(i) Detaljert instruksjon for hvert trinn.

(ii) Arkiveringsplaner.

(iii) Interrupt / Restart prosedyrer.

(iv) JCL-oppføringer for hvert trinn.

(v) Systemstrøm.

2. Data forberedelser:

Dokumentasjonene skal gi eksempler på alle inngangsdokumenter, kortoppsett, rekordoppsett, spesielt instrument for databehandling, retensjonsplaner for data.

3. I / O-kontroll:

(i) Kvalitetskontrollkontrollprosedyrer for hvert trinn.

(ii) Levering (rapporter) detaljer

(iii) Behandlingsplaner

(iv) Dokumentkvitteringsdetaljer.

(c) Dokumentasjon for programmerere:

For hvert program bør det være en programmappe som dekker følgende:

(i) Kildeprogramoppføring.

(ii) Utvikling av systemtestløp.

(iii) Programspesifikasjoner I / O-oppsett.

(iv) JCL notering.

(v) Bruk av spesiell teknikk

(vi) Testresultater

(vii) Testdataoppføring

(viii) Programlogikk flytdiagram.

(ix) Endringer i spesifikasjoner under program.

Det endelige dokumentet eller den endelige rapporten skal være faglig skrevet og bundet med klare illustrasjoner med begrensede tekniske vilkår. Hvis toppledere i organisasjonen kan forstå konseptene i det nye systemet, vil de sannsynligvis vise takknemlighet og støtte fremtidige prosjekter.