Hvordan beskrive programmet. Beskrivelse av programstrukturen

Dette dokumentet er av typen programvaredrift. Gjelder et program, kompleks, programvarepakke, programvarekomponent eller system.
Målgruppe: personer som tar beslutninger om kjøp og idriftsettelse av programmet. Dokumentet inneholder informasjon om funksjonaliteten til programmet og dets anvendelsesområde.

GOST og standarder

Strukturen og utformingen av dokumentet bestemmes i.
Informasjonsdel (merknader og innhold) iht.

I hvilke tilfeller er det nødvendig

Dokumentet er nødvendig for å informere potensielle brukere og kjøpere om formålet med programmet og påføringsmetoder. Mer egnet for ledere (spesialister, systemadministratorer) som uavhengig bestemmer seg for å kjøpe programmet og sette det i drift.

De kan få all nødvendig informasjon fra dette dokumentet: en beskrivelse av programmet og dets bruk.

Programbeskrivelsen og søknadsbeskrivelsen indikerer:

Problemer som programmet løser;
Ressurser brukt på arbeid;
Innledende informasjon;
Produksjon.

Det legges vekt på den beskrivende delen av programmet, dets funksjoner og formål. I mindre grad på beskrivelsen av søknaden. Det lages en spesifikt beskrivelse av programmets muligheter og oppgavene det løser, og ikke om dets interne struktur. Med visse funksjoner i programmet er det mulig å kombinere seksjoner eller introdusere nye (ekstra).

Strukturen til programbeskrivelsen (GOST 19.402-78):

1. Generell informasjon.
2. Funksjonell hensikt med programmet.
3. Beskrivelse av den logiske strukturen.
4. Tekniske midler som brukes.
5. Ring og last ned.
6. Inndata.
7. Avtrykk.

Strukturen til applikasjonsbeskrivelsen (GOST 19.502-78):

1. Formålet med programmet.
2. Betingelser for bruk.
3. Beskrivende del av oppgaven.
4. Inn- og utdata.
5. applikasjoner (tabeller, illustrasjoner osv.).

Du kan bestille utvikling av et dokument eller et komplett sett med programvaredokumentasjon.

Generell informasjon.

Programmet heter jane og er lagret i filen jane.dpr. Programmet bruker hjelpemoduler main, new, dmData, about, henholdsvis lagret i filene main.pas, new.pas, about.pas, dmData.pas. Programmet er skrevet i programmeringsspråket Delphi. Programmet bruker data fra databasetabeller otdel.db, sotrudnik.db, family.db, obrazovanie.db

Funksjonelt formål.

Implementering av en dialoggraf.

Vanligvis inkluderer grensesnittet mellom brukeren og datamaskinen en skjerm, et tastatur og en mus, som er det som presenterer informasjon til brukeren og mottar informasjon fra brukeren. ,

Praktisk talt er et program skrevet ved hjelp av Delphi tilgjengelig gjennom et grafisk brukergrensesnitt. Det grafiske grensesnittet implementert av applikasjonsprogrammet er en slags dialog som oppstår mellom datamaskinen og brukeren. Med andre ord, et grensesnitt er den delen av et program som, for å utføre visse funksjoner, oversetter brukerhandlinger til en eller flere forespørsler og gir tilbakemelding til brukeren i samsvar med rekkefølgen av hans handlinger.

Brukeren har muligheten til å velge systemfunksjoner ved hjelp av trykknapper og piktografiske menyer. Brukeren ser innholdet i databasen foran seg i form av et skjermdokument. Samhandling med bruker utføres gjennom skjermskjemaer. Implementeringen av dialoggrafen er vist i figur 17.

Figur 17. Tre av skjermformer

Beskrivelse av den logiske strukturen.

Programmet er arrangementsstyrt. Når du klikker på en knapp, sendes en melding til programmet, og den tilsvarende behandlerprosedyren kalles, som behandler denne hendelsen. Resultatene av behandlingen kan sees på LCD-skjermen. For eksempel: når du klikker på "Arbeid"-knappen i "Diplomprosjekt"-skjemaet, kalles prosedyren i den nye modulen, som skjuler "Diplomprosjekt"-skjemaet, viser "Personalregnskap"-skjemaet på monitorskjermen , og kontrollen overføres til hovedmodulen.

For å kjøre programmet må du laste ned Delphi-skallet på din personlige datamaskin og kompilere kildeteksten til programmet i filen jane.dpr. Ring exe-filen og arbeid med den. Før du starter arbeidet, må du gå gjennom autorisasjonsprosedyren (Figur 18).

Figur 18. Skjema for inntasting av passord

Inn- og utdata.

Inndata:

avdelingsnavn,

Navn på sjefen,

Fullt navn på ansatte, stilling,

ansettelsesdato,

sted for siste arbeid,

tjenestetid fra opptaksdatoen,

et tegn på utdanning,

et tegn på å ha en familie,

antall barn,

Familie status,

fødselsdato,

type utdanning,

form for utdanning,

utdanningsinstitusjon,

utløpsdato,

spesialitet.

Utdata: alle resultater av brukerhandlinger når du arbeider med databaser vises på monitorskjermen; disse resultatene, vist som en database på skjermen, er utdata til programmet. Resultatet av å jobbe med denne "Personal Accounting"-databasen kan også være generering av bestillinger og utskrift av dem, noe som i stor grad letter brukerens arbeid og eliminerer behovet for manuelt å utarbeide dokumenter som ordre om oppsigelse eller ansettelse av ansatte og deres personlige kort.

5.6. EKSEMPEL PÅ BESKRIVELSE AV PROGRAMMET "TEKSTREDAKTØR"

Nedenfor er et eksempel på en beskrivelse av tekstredigeringsprogrammet, satt sammen av en av studentene. Eksemplet gir først den eksterne funksjonsspesifikasjonen og deretter den interne spesifikasjonen.

"Text Editor"-programmet er utviklet for å lage nye og korrigere eksisterende MS DOS-tekstfiler i en interaktiv (bruker-datamaskin) driftsmodus. Datamaskinen genererer en skjerm med et vindu der en del av teksten fra en tekstfil vises (skjermoppsettet tilsvarer den interne editoren til Norton Commander-programmet). Brukeren er utstyrt med muligheten til å sette inn i teksten i skjermvinduet et hvilket som helst tastaturtegn bak tegnet markert på skjermen med markøren. Unntaket er en rekke symboler som er tegn på kontrollkommandoer eller ubrukte symboler (en liste med symboler er gitt). Etter at brukeren har utstedt en skrivekommando, blir alle tekstendringer gjort av brukeren skrevet til filen.

Det grunnleggende prinsippet for bruk av tekstredigereren er å overføre tekstlinjer fra de nødvendige delene av filen, først til en bufferminnematrise på 65535 byte (tegn) i lengde, og deretter kopiere de nødvendige linjene fra buffermatrisen til skjermvindu.

Programmet startes av en kommando som angir navnet på filen som redigeres. Deretter, inntil det riktige filnavnet er spesifisert, kan algoritmen "Be brukeren om å angi eller korrigere filnavnet" begynne å bli utført gjentatte ganger.

Deretter settes startverdiene til den strukturerte variabelen "Koordinatsystem", som inneholder følgende felt: "Markørposisjon i forhold til filen"; "Markørposisjon i forhold til editorens buffervindu"; "Plasseringen til editorens buffervindu i forhold til filen."

Etterpå tømmes bufferarrayen til strengvariabeleditoren fra 5 * 23 = 115 linjer med 225 tegn hver.

Deretter, med "First line of file"-parameteren, utføres algoritmen "Laster linjer av filen, starter fra den spesifiserte linjen, inn i editorens bufferarray". Deretter, før brukeren sender inn en av kommandoene for å fullføre redigeringen med lagring av informasjon (eller uten lagring), utføres hovedprogramsløyfen. Til slutt, hvis en fullføringskommando ble gitt under lagring av informasjon, blir informasjonen fra bufferarrayet skrevet om til en fil. Programmet avsluttes med å tømme skjermen.

Kontroll av navnet på filen som redigeres er som følger. Hvis en fil med det angitte navnet ikke finnes på disken, vises en advarselsmelding som indikerer at en ny "tom" fil blir opprettet. Hvis brukeren ikke spesifiserte navnet på filen som ble redigert eller nektet å jobbe med den opprettede "tomme" filen, avsluttes programmet unormalt med en forklaring av årsaken til oppsigelsen.

Inne i hovedprogramløkken utføres en serie på tre sekvensielle handlinger. "Algorithm display" viser 23 linjer med tekst fra en buffermatrise på skjermen, med start fra en gitt linje. Deretter settes visningsmarkøren til den angitte skjermposisjonen. Koden til den trykket tasten legges inn. Hvis koden til den trykket tasten samsvarer med en kontrolltast, utføres en av de alternative handlingene for å utføre kommandoen som tilsvarer denne tasten. Ellers settes tegnet inn i teksten.

Fra boken Programvarepakker. Kvalitetskrav og testing forfatter forfatter ukjent

Fra Linux for brukerboken forfatter Kostromin Viktor Alekseevich

12.2. Programmer for å se tekster i forskjellige formater Jeg leste et sted at UNIX-tradisjonen var å lage en egen kommando for hver elementær handling. Denne observasjonen er godt illustrert av tilstedeværelsen i Linux av en hel rekke separate programmer for visning av filer.

Fra boken Introduksjon til OpenGL forfatter Computers Forfatter ukjent -

12.5.3 CoolEdit - innebygd redaktør av Midnight Commander-programmet CoolEdit er et brukervennlig program med kontrolltastkombinasjoner som er kjent for de fleste brukere (spesielt de som har jobbet med Norton Commander under DOS eller FAR under WINDOWS). I tillegg må det tas hensyn til det

Fra boken Programmeringsteknologier forfatter Kamaev V A

Eksempelprogram Resultatet av å utføre dette programmet er konstruksjonen av et tetraeder med ringer som roterer rundt det, som en tekstur påføres. I MS Visual C++-miljøet kan programmet kompileres uten endringer, men ved kompilering i Borland C++ må du kommentere ut

Fra boken Hva Delphi-bøker ikke skriver om forfatter Grigoriev A.B.

5.5. EKSEMPEL PÅ UTVIKLING AV EN BESKRIVELSE AV PROSESSEN "KOKE VANN I EN KETTEL" Den trinnvise implementeringen av designprosedyren er vist nedenfor ved å bruke eksempelet på å utvikle en beskrivelse av prosessen "Kokende vann i en kjele". Fyll selv ut denne beskrivelsen med visuelle tegninger på ark 1. Ark 2.

Fra boken Programmering i Ruby [Språkideologi, teori og anvendelsespraksis] av Fulton Hal

Fra boken Programming in Prolog for Artificial Intelligence forfatter Bratko Ivan

1.2.5. Eksempelprogram I en hvilken som helst veiledning er det første programmet som skriver ut strengen Hallo verden! alltid gitt, men vi skal se på noe mer meningsfullt. Her er et lite interaktivt konsollprogram som lar deg konvertere temperatur fra Fahrenheit til Fahrenheit

Fra boken VBA for Dummies av Steve Cummings

16.1.3. Eksempel på programmering Prøvedrevne systemer har sin egen spesielle programmeringsstil som krever en spesifikk programmerers tenkning. Vi snakker i dette tilfellet om programmering i form av mønstre. Tenk som en illustrasjon

Fra boken Hvordan finne og laste ned alle filer på Internett forfatter Reitman M.A.

Eksempelprogram For å gjøre diskusjonen om VBA-elementhierarkiet litt mindre abstrakt, la oss se på modulkoden nedenfor. Denne modulen inneholder alle elementene nevnt ovenfor (unntatt prosjektet, siden moduler er inneholdt i prosjekter, og

Fra boken Linux: The Complete Guide forfatter Kolisnichenko Denis Nikolaevich

Tekstredigering og websideredigerer OpenOffice.org Writer Tekstbehandler OpenOffice.org Writer (heretter ganske enkelt Writer) er den mest kjente applikasjonen til kontorprogramvarepakken. Dette programmet lar deg lage og redigere tekstdokumenter, sette inn bilder og

Fra boken Protection from Hackers of Corporate Networks forfatter forfatter ukjent

21.4. Eksempel på et program i C I avsnitt 9.2.3 snakket jeg om prosesstilstander og listet blant dem opp «zombie»-tilstanden. En zombie er en prosess som allerede er avsluttet, men dens forelder har ennå ikke mottatt et signal om at den har avsluttet og har ikke fjernet strukturen fra prosesstabellen. Dette kan skje

Fra boken The C Language - A Guide for Beginners av Prata Steven

22.3. Et eksempel på programfeilsøking La oss skrive et program som tilbakestiller elementene i array a. Ja, programmet gjør ikke noe nyttig, men ved å bruke eksemplet kan du demonstrere hvordan du arbeider med gdb-debuggeren Her er programoversikten: Listing 22.1. Demonstrasjonsprogram

Fra boken Programmering for Linux. Profesjonell tilnærming av Mitchell Mark

Eksempel på et sårbart program Ved å bruke et eksempel på et sårbart program, la oss se på hvordan en angriper kan utnytte sårbarheter i formatstrenger for å nå sine mål. Av størst interesse er metoder for fjernutnyttelse av sårbarheter

Fra forfatterens bok

EKSEMPEL PÅ ET ENKELT PROGRAM PÅ C-SPRÅK La oss se på et enkelt program på C-språk. Det skal sies med en gang at vi trenger et slikt eksempel bare for å identifisere noen av hovedtrekkene til ethvert program skrevet på C-språket. Deretter vil vi gi forklaringer for hver linje, men før

Fra forfatterens bok

EKSEMPEL PROGRAM I fig. 5.8 viser et program som kan være nyttig for de som løper, og som illustrerer noen av poengene i dette kapittelet. Det ser ganske langt ut, men alle beregninger i det er utført av seks utsagn plassert

Fra forfatterens bok

5.1.6. Eksempelprogram Programmet i Listing 5.1 illustrerer minnedelingsteknikken Listing 5.1. (shm.c) Eksempel på minnedeling#inkluder #inkludere #inkludere int main() ( int segment_id; char* delt_minne; struct shmid_ds shmbuffer; int segment_size; const

Programtekst

Eksempel.

Programspesifikasjon

Spesifikasjonsdelen gir det nøyaktige navnet på programmet og dets sammensetning. Spesifikasjonsskjemaet er gitt i vedlegg 2. Spesifikasjonskolonnene fylles ut som følger:

1. i kolonnen "Betegnelse" angi betegnelsen på hovedprogramvaren
komponenter;

2. i "Navn"-kolonnen angi det fulle navnet på den tilsvarende komponenten;

3. i "Merk"-kolonnen - tilleggsinformasjon relatert Til programmer skrevet i spesifikasjonen.

Den kjørbare filen til "Game "Labyrinth""-programmet heter Labirint.exe og er plassert på stasjon F i Student\Kursov\Labirint-katalogen. Prosjektsammensetning:

Navn	Betegnelse	Merk
Acl	Plantegningsfil	Opprettet i applikasjonen
Helpi	Hjelpefil	Opprettet i applikasjonen
Labirint.Dof	Prosjektinnstillingsfil	Inneholder gjeldende prosjektinnstillinger: kompilator- og linkerinnstillinger, tjenestekatalognavn, betingede direktiver
Labirint.Dpr	Prosjektfil	Kobler til alle filene som utgjør programmet
Labirint.Dsk	Fil som inneholder	Inneholder informasjon om hvilke vinduer som er åpne og i hvilke posisjoner de er plassert
Labirint.Res	Ressursfil	Inneholder piktogrammer, grafiske bilder
Enhet 1.Pas	Programvaremodulfil for skjema nr. 1	Definerer funksjonaliteten til skjema nr. 1.
Enhet2.Pas	Programvaremodulfil for skjema nr. 2	Definerer funksjonaliteten til skjema nr. 2.
U»it3.Pas	Programvaremodulfil for skjema nr. 3	Definerer funksjonaliteten til skjema nr. 3.
Unitl.Dfm	Skjemafil #1	Inneholder en liste over egenskapene til alle komponenter inkludert i skjema nr. 1.
Enhet2.Dfm	Skjemafil #2	Inneholder en liste over egenskapene til alle komponenter inkludert i skjema nr. 2.
Enhet3.Dfm	Shape fil #3	Inneholder en liste over egenskapene til alle komponenter inkludert i skjema nr. 3.
Uuitl.Dcu	Objektfil for Unit1. Pas	Kompilert versjon av Unit1.Pas.
Uuit2.Dcu	Objektfil for Unit2.Pas	Kompilert versjon av Unit2.Pas.
Enhet3.Dcu	Objektfil for Unit3.Pas	Kompilert versjon av UnM.Pas.

En fullstendig oversikt over programmet er gitt. Lister over alle moduler med kommentarer er gitt.

"Programbeskrivelse"-delen i henhold til GOST 19.402-78 bør inneholde følgende underseksjoner:

· generell informasjon;

· funksjonelt formål;

· beskrivelse av den logiske strukturen;

· tekniske midler som brukes;

· inndata;

· utgang.

Individuelle seksjoner kan kombineres. Noen punkter i denne delen gjentar deler av det tekniske prosjektet. Slike repetisjoner er gitt av GOST, siden det på stadiet av den detaljerte designen oppstår noen tillegg eller endringer i sammensetningen av de tekniske midlene eller programmet. Mer spesifikke og nøyaktige data er gitt her.

Underseksjonen "Generell informasjon" bør angi: betegnelse og navn på programmet; programvare nødvendig for driften av programmet; programmeringsspråk som programmet er skrevet på.

Underavsnittet "Funksjonelt formål" må angi hvilke klasser av problemer som skal løses og (eller) formålet med programmet og informasjon om funksjonelle begrensninger for bruk.

Underavsnittet "Beskrivelse av den logiske strukturen" bør angi metodene 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.

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

Underseksjonen "Ring og last" må angi metoden for å kalle opp programmet fra det aktuelle lagringsmediet og inngangspunktene til programmet.

Underavsnittet "Inndata" skal angi: art, organisering og foreløpig utarbeidelse av inngangsdata, format, beskrivelse og metode for koding av inndata.

Underavsnittet "Utdata" skal angi: arten, organiseringen og den foreløpige forberedelsen av utdataene, format, beskrivelse og metode for koding av utdataene.

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;
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).

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