• hjem
  •  > 
  • Internett og kommunikasjon
  •  > 
  • Eksempel på dokumentbeskrivelse av programmet GOST 19.402 787. Ung jagerflykurs: Om utarbeidelse av programdokumentasjon (dokumentasjon)

Eksempel på dokumentbeskrivelse av programmet GOST 19.402 787. Ung jagerflykurs: Om utarbeidelse av programdokumentasjon (dokumentasjon)

INTERSTATE STANDARD
Samlet system for programdokumentasjon GOST 19.402-78
PROGRAMBESKRIVELSE
Samlet system for programdokumentasjon.
Programbeskrivelse
Dato for introduksjon 01.01.1980

Utgave (januar 2010) med Endring nr. 1, godkjent i september 1981 (IUS 11-81).

Ved dekret fra USSR State Committee on Standards datert 18. desember 1978 nr. 3350 ble innføringsdatoen satt til kl. 01.01.80

1. Denne standarden fastsetter innholdet og kravene til innholdet i programdokumentet "Programbeskrivelse", definert av GOST 19.101-77.

Standarden samsvarer fullt ut med ST SEV 2092-80.

(Endret utgave, endring nr. 1)

2. Strukturen og utformingen av dokumentet er etablert i samsvar med GOST 19.105-79.

Avhengig av funksjonene i programmet, er det mulig å introdusere flere seksjoner eller kombinere individuelle seksjoner.

4. I delen "Generell informasjon" må følgende angis:

betegnelse og navn på programmet;

programvare nødvendig for driften av programmet;

programmeringsspråk som programmet er skrevet på.

5. Avsnittet "Funksjonelt formål" må angi hvilke klasser av problemer som løses og (eller) formålet med programmet og informasjon om funksjonelle begrensninger på søknaden.

6. I avsnittet "Beskrivelse av den logiske strukturen" skal følgende angis:

programalgoritmer;

metoder som brukes;

programstruktur med en beskrivelse av funksjonene til komponentene og forbindelsene mellom dem;

kobling av programmet med andre programmer.

Beskrivelsen av den logiske strukturen til programmet er utført under hensyntagen til teksten til programmet på kildespråket.

3-6. (Endret utgave, endring nr. 1).

7. Avsnittet "Tekniske midler som brukes" skal angi hvilke typer elektroniske datamaskiner og enheter som brukes når programmet kjøres.

metode for å kalle programmet fra det tilsvarende lagringsmediet;

inngangspunkter til programmet.

Du kan spesifisere nedlastingsadresser, informasjon om RAM-bruk og programstørrelse.

9. I delen "Inndata" må følgende angis:

natur, organisering og foreløpig utarbeidelse av inndata;

format, beskrivelse og metode for koding av inndata.

10. I avsnittet "Utdata" må følgende angis:

art og organisering av utdata;

format, beskrivelse og metode for koding av utdataene.

11. Det er tillatt å illustrere innholdet i avsnitt med forklarende eksempler, tabeller, diagrammer, grafer.

12. Vedlegget til programbeskrivelsen kan inneholde ulike materialer som er upassende å inkludere i deler av beskrivelsen.

7-12. (Innført i tillegg, endringsforslag nr. 1).

Dette verket er ikke beskyttet av opphavsrett.
I samsvar med artikkel 1259 i den russiske føderasjonens sivilkode, offisielle dokumenter fra statlige organer og lokale selvstyreorganer i kommunene, inkludert lover, andre forskrifter, rettsavgjørelser, annet materiale av lovgivende, administrativ og rettslig karakter, offisielle dokumenter internasjonale organisasjoner er ikke underlagt opphavsrett. , så vel som deres offisielle oversettelser, folkekunstverk (folklore), rapporter om hendelser og fakta som er rent informasjonsmessig (nyhetsreportasjer, TV-programmer, kjøretøyplaner, etc. .).

Denne standarden er fokusert på å dokumentere det resulterende utviklingsproduktet.

Det er strengt tatt to ulike dokumenter, som imidlertid har mye til felles. Dette er en GENERELL BESKRIVELSE (GOST 19.502-78) og en BESKRIVELSE AV PROGRAMMET (GOST 19.402-78). Men på grunn av det faktum at det er veldig vanskelig å faktisk lage begge med høy kvalitet, uten å ty til nesten fullstendig duplisering og rive ut deler, ville det være nok å implementere ett, mer generelt, "hybrid" dokument. La oss kalle det "Programbeskrivelse".

Faktisk kan "Programbeskrivelsen" i innholdet suppleres med seksjoner og avsnitt hentet fra standardene for andre beskrivende dokumenter og manualer: GOST 19.404-79 ESPD. Forklarende notat, GOST 19.503-79 ESPD. Systemprogrammeringsveiledning, GOST 19.504-79 ESPD. Programmererveiledning, GOST 19.505-79 ESPD. Brukerhåndbok og så videre. Spesielt fra den forklarende merknaden kan du ta et diagram over algoritmen, en generell beskrivelse av algoritmen og (eller) funksjonen til programmet, samt begrunnelsen for de vedtatte tekniske og teknisk-økonomiske beslutningene.

Beskrivelsen av programmet skal inneholde en informasjonsdel - merknad og innhold.

Hoveddelen av dokumentet bør bestå av en innledende del og følgende seksjoner:
funksjonelt formål;
beskrivelse av logikk.
Betingelser for bruk;
sammensetning og funksjoner.

Avhengig av spesifikasjonene til programmet, kan flere seksjoner bli introdusert.

I Innledende del Dokumentet gir generell informasjon om programmet - fullt navn, betegnelse, dets mulige anvendelser, etc.

For eksempel: Programmet "Automatisert arbeidsstasjon for selvgående våpenutvikler" er beregnet på... implementert på.... Programmet støtter...

I kapittel Hensikt angi formålet med programmet og gi en generell beskrivelse av funksjonen til programmet, dets hovedegenskaper, informasjon om begrensningene som er pålagt programmets omfang, og angi også hvilke typer elektroniske datamaskiner og enheter som brukes under drift.

For eksempel: Programmet er utviklet for å løse problemer... Programmet representerer kjernen i en automatisert arbeidsstasjon...

Brukeren har mulighet til å..., implementere..., kjøre..., analysere..., få resultater av analyse og bearbeiding..., bygge... osv.

I kapittel " Beskrivelse av logikk" indikerer:
beskrivelse av strukturen til programmet og dets hoveddeler (for eksempel: Programmet inkluderer følgende:
brukergrensesnitt,
modul for å bestemme stier i en graf,
overføringsfunksjonsberegningsmodul,
modul for å konstruere amplitude- og fasefrekvenskarakteristikk,
modul for å konstruere en respons på en polynomisk påvirkning,
tekstredigerer)
beskrivelse av funksjonene til komponentene og forbindelser mellom dem;
For eksempel: Programmet består av seks moduler: grensesnittmodul; definisjonsmodul...; beregningsmodul...; modul...osv..
Grensesnittmodulen er bygget på to typer dialoger: en spørsmål-svar-dialog og en meny-dialog. Grensesnittmodulen kontrollerer...
Definisjonsmodul... Det er...
Beregningsmodul...osv.
informasjon om programmeringsspråket;
For eksempel: Programmet er skrevet på språket ... ved hjelp av en kompilator ...
beskrivelse av inn- og utdata for hver av komponentene;

For eksempel : LEGG INN DATA. Inndataene for programmet er en tekstfil som beskriver den utvidede forekomstmatrisen til grafen til systemet som studeres.

PRODUKSJON. Utgangen er:

· grafisk og tekstinformasjon som vises på skjermen (systemanalyseresultater);

· filer i et av de grafiske formatene - kopier av bildet av de konstruerte egenskapene (frekvensrespons, faserespons, etc.);

· tekstfiler - rapporter om utført forskning;

· diagnostikk av systemtilstanden og meldinger om alle feil som oppstår.

· beskrivelse av logikken til komponentene (om nødvendig bør det skrives en beskrivelse av programdiagrammer). Når man skal beskrive logikken til et program, er det naturligvis nødvendig å knytte det til teksten i programmet.

I kapittel Sammensetning og funksjoner angi en beskrivelse av programmers sammensetning og funksjon og metodene som brukes for å løse problemer.

I kapittel Betingelser for bruk betingelsene som er nødvendige for gjennomføringen av programmet er angitt (krav til de tekniske midlene som er nødvendige for dette programmet og andre programmer, generelle kjennetegn ved input- og outputinformasjon, samt krav og betingelser av organisatorisk, teknisk og teknologisk art, etc. ).

For eksempel : Programmet betjenes på en personlig datamaskin (PC) av typen IBM PC/AT. For å jobbe i interaktiv modus brukes en skjerm, tastatur og mus. For å støtte grafikkmodus kreves en EGA (VGA)-adapter. Inndata lagres på disketter og/eller harddisker. Programmet kjører under OS...

Vedlegget til beskrivelsen kan inneholde referansemateriale (illustrasjoner, tabeller, grafer, eksempler osv.)

Og ikke glem å angi navnet på lastemodulen, samt en beskrivelse av hele prosedyren

Ringer og starter systemet

Ved dekret fra USSR State Committee on Standards datert 18. desember 1978 nr. 3350, ble introduksjonsdatoen fastsatt

fra 01.01.1980

1. Denne standarden fastsetter sammensetningen og kravene til innholdet i programdokumentet "Programbeskrivelse", definert av GOST 19.101-77.

Standarden samsvarer fullt ut med ST SEV 2092-80.

2. Strukturen og utformingen av dokumentet er etablert i samsvar med GOST 19.105-78.

Det er obligatorisk å utarbeide informasjonsdelen (merknader og innhold).

3. Beskrivelsen av programmet må inneholde følgende avsnitt:

generell informasjon;

funksjonelt formål;

beskrivelse av den logiske strukturen;

inndata;

produksjon.

Avhengig av funksjonene i programmet, er det mulig å introdusere flere seksjoner eller kombinere individuelle seksjoner.

4. I delen "Generell informasjon" må følgende angis:

betegnelse og navn på programmet;

programvare nødvendig for driften av programmet;

programmeringsspråk som programmet er skrevet på.

5. Avsnittet "Funksjonelt formål" må angi hvilke klasser av problemer som løses og (eller) formålet med programmet og informasjon om funksjonelle restriksjoner på bruk.

6. I delen "Beskrivelse av den logiske strukturen" skal følgende angis:

program algoritme;

metoder som brukes;

programstruktur ved å beskrive funksjonene til komponentdelene og forbindelsene mellom dem;

kobling av programmet med andre programmer.

Beskrivelsen av den logiske strukturen til programmet er utført under hensyntagen til teksten til programmet på kildespråket.

3-6. (Endret utgave, endring nr. 1).

7. Avsnittet "Tekniske verktøy brukt" skal angi hvilke typer elektroniske dataenheter som brukes når programmet kjøres.

metode for å kalle programmet fra det tilsvarende lagringsmediet;

inngangspunkter til programmet.

Du kan spesifisere nedlastingsadresser, informasjon om RAM-bruk og programstørrelse.

9. I avsnittet "Inndata" må følgende angis:

natur, organisering og foreløpig utarbeidelse av inndata;

format, beskrivelse og metode for koding av inndata.

10. I avsnittet "Utdata" må følgende angis:

art og organisering av utdata;

format, beskrivelse og metode for koding av utdata.

11. Det er tillatt å illustrere innholdet i avsnitt med forklarende eksempler, tabeller, diagrammer, grafer.

12. I vedlegg til beskrivelsen av programmet er det tillatt å inkludere diverse materiell som er upassende å inkludere i avsnitt av beskrivelsen.

7-12. (Innført i tillegg, endringsforslag nr. 1).

Samlet system for programdokumentasjon

PROGRAMBESKRIVELSE

Samlet system for programdokumentasjon. Programbeskrivelse.

Ved dekret fra USSR State Committee on Standards datert 18. desember 1978 nr. 3350, ble introduksjonsdatoen fastsatt
fra 01.01. 1980
1. Denne standarden fastsetter sammensetningen og kravene til innholdet i programdokumentet "Programbeskrivelse", definert av GOST 19.101-77.
Standarden samsvarer fullt ut med ST SEV 2092-80.
2. Strukturen og formatet til dokumentet er etablert i samsvar med GOST 19.105-78.
Det er obligatorisk å utarbeide informasjonsdelen (merknader og innhold).
3. Beskrivelsen av programmet må inneholde følgende avsnitt:

  • generell informasjon;
  • funksjonelt formål;
  • beskrivelse av den logiske strukturen;
  • tekniske midler som brukes;
  • inndata;
  • produksjon.

Avhengig av funksjonene i programmet, er det mulig å introdusere flere seksjoner eller kombinere individuelle seksjoner.
4. I delen "Generell informasjon" må følgende angis:
betegnelse og navn på programmet;
programvare nødvendig for driften av programmet;
programmeringsspråk som programmet er skrevet på.
5. Avsnittet "Funksjonelt formål" må angi hvilke klasser av problemer som løses og (eller) formålet med programmet og informasjon om funksjonelle begrensninger på søknaden.
6. I avsnittet "Beskrivelse av den logiske strukturen" skal følgende angis:

  • program algoritme;
  • metoder som brukes;
  • programstruktur med en beskrivelse av funksjonene til komponentene og forbindelsene mellom dem;
  • kobling av programmet med andre programmer.

Beskrivelsen av den logiske strukturen til programmet er utført under hensyntagen til teksten til programmet på kildespråket.
3-6.(Endret utgave, endring nr. 1).
7. Avsnittet "Tekniske verktøy brukt" skal angi hvilke typer elektroniske datamaskiner og enheter som brukes når programmet kjøres.

  • metode for å kalle programmet fra det tilsvarende lagringsmediet;
  • inngangspunkter til programmet.

Du kan spesifisere nedlastingsadresser, informasjon om RAM-bruk og programstørrelse.
9. I avsnittet "Inndata" må følgende angis:

  • natur, organisering og foreløpig utarbeidelse av inndata;
  • format, beskrivelse og metode for koding av inndata.

10. I avsnittet "Utdata" må følgende angis:

  • art og organisering av utdata;
  • format, beskrivelse og metode for koding av utdataene.

11. Det er tillatt å illustrere innholdet i avsnitt med forklarende eksempler, tabeller, diagrammer, grafer.
12. Vedlegget til programbeskrivelsen kan inneholde ulike materialer som er upassende å inkludere i deler av beskrivelsen.
7-12 (Innført i tillegg, endringsforslag nr. 1).

STATSSTANDARD FOR USSR UNION

Samlet system for programdokumentasjon

Ved dekret fra USSR State Committee on Standards datert 18. desember 1978 nr. 3350, ble introduksjonsdatoen fastsatt fra 01.01. 1980

1. Denne standarden fastsetter sammensetningen og kravene til innholdet i programdokumentet "Programbeskrivelse", definert av GOST 19.101-77.

Standarden samsvarer fullt ut med ST SEV 2092-80.

2. Strukturen og formatet til dokumentet er etablert i samsvar med GOST 19.105-78.

Det er obligatorisk å utarbeide informasjonsdelen (merknader og innhold).

3. Beskrivelsen av programmet må inneholde følgende avsnitt:

  • generell informasjon;
  • funksjonelt formål;
  • beskrivelse av den logiske strukturen;
  • tekniske midler som brukes;
  • inndata;
  • produksjon.

Avhengig av funksjonene i programmet, er det mulig å introdusere flere seksjoner eller kombinere individuelle seksjoner.

4. I delen "Generell informasjon" må følgende angis:

  • betegnelse og navn på programmet;
  • programvare nødvendig for driften av programmet;
  • programmeringsspråk som programmet er skrevet på.

5. Avsnittet "Funksjonelt formål" må angi hvilke klasser av problemer som løses og (eller) formålet med programmet og informasjon om funksjonelle begrensninger på søknaden.

6. I avsnittet "Beskrivelse av den logiske strukturen" skal følgende angis:

  • program algoritme;
  • metoder som brukes;
  • programstruktur med en beskrivelse av funksjonene til komponentene og forbindelsene mellom dem;
  • kobling av programmet med andre programmer.

Beskrivelsen av den logiske strukturen til programmet er utført under hensyntagen til teksten til programmet på kildespråket.

3-6.(Endret utgave, endring nr. 1).

7. Avsnittet "Tekniske verktøy brukt" skal angi hvilke typer elektroniske datamaskiner og enheter som brukes når programmet kjøres.

  • metode for å kalle programmet fra det tilsvarende lagringsmediet;
  • inngangspunkter til programmet.

Du kan spesifisere nedlastingsadresser, informasjon om RAM-bruk og programstørrelse.

9. I delen "Inndata" må følgende angis:

  • natur, organisering og foreløpig utarbeidelse av inndata;
  • format, beskrivelse og metode for koding av inndata.

10. I avsnittet "Utdata" må følgende angis:

  • art og organisering av utdata;
  • format, beskrivelse og metode for koding av utdataene.

11. Det er tillatt å illustrere innholdet i avsnitt med forklarende eksempler, tabeller, diagrammer, grafer.

12. Vedlegget til programbeskrivelsen kan inneholde ulike materialer som er upassende å inkludere i deler av beskrivelsen.

7-12.(Innført i tillegg, endringsforslag nr. 1).

*Nyutgivelse (november 1987) med endring nr. 1, godkjent i september 1981 (IUS 11-81)