Primjer opisa programa prema GOST-u. Tečaj Mladi borac: O izradi programske dokumentacije (dokumentacija). Koje funkcije obavlja vaša aplikacija?

Ovaj dokument odnosi se na softverski operativni tip. Primjenjuje se na program, kompleks, softverski paket, softversku komponentu ili sustav.
Ciljana publika: osobe koje donose odluke o kupnji i naručivanju programa. Dokument sadrži podatke o funkcionalnost program i njegov opseg.

GOST-ovi i standardi

Struktura i dizajn dokumenta određeni su u.
Informacijski dio(napomene i sadržaj) u skladu s.

U kojim slučajevima je potrebno

Dokument je neophodan za informiranje potencijalnih korisnika i kupaca o namjeni programa i načinu primjene. Pogodniji za menadžere (specijaliste, administratori sustava), koji samostalno odluče kupiti program i staviti ga u rad.

Iz ovog dokumenta mogu dobiti sve potrebne informacije: opis programa i njegove primjene.

Opis programa i opis aplikacije pokazuju:

Problemi koje program rješava;
Resursi utrošeni za rad;
Uvodne informacije;
Izlaz.

Naglasak je na opisnom dijelu programa, njegovim funkcijama i namjeni. U manjoj mjeri na opis aplikacije. Opis je napravljen konkretno o mogućnostima programa i problemima koje rješava, a ne o njegovim unutarnja struktura. Uz pojedine mogućnosti programa moguće je kombinirati dijelove ili uvesti nove (dodatne).

Struktura opisa programa (GOST 19.402-78):

1. Opće informacije.
2. Funkcionalna namjena programa.
3. Opis logičke strukture.
4. Tehnička sredstva, koji se koriste.
5. Nazovite i preuzmite.
6. Ulazni podaci.
7. Otisak.

Struktura opisa aplikacije (GOST 19.502-78):

1. Svrha programa.
2. Uvjeti korištenja.
3. Opisni dio zadatka.
4. Ulazni i izlazni podaci.
5. aplikacije (tablice, ilustracije i sl.).

Možete naručiti izradu dokumenta ili kompletan set softverska dokumentacija.

Automatizacija knjižničnih procesa

Dokumentacija baze podataka "Popis vlasnika garažnih zadruga"

Baza podataka "Popis vlasnika garažnih zadruga" sastoji se od tri obrasca. Glavna tablica je kreirana sa koristeći Access. prvi obrazac sadrži sljedeće elemente: Podaci (za komunikaciju s Access tablicama pomoću svojstava DatabaseName i DataSource)...

Informacijsko-referentni sustav "Kontrola rada promotora"

Katalog elektrotehnike

Program se sastoji od tri oblika. Prvi obrazac ima lozinku za ovaj program. Obrazac ima fiksna veličina. Sadrži tekstualno polje (TextBox) u koje korisnik upisuje lozinku, kao i gumb (CommandButton)...

Pisanje računalna igra"Obori avion"

U programu glavni zadatak obavlja animacija. Omogućuje vam implementaciju kretanja svih objekata koji se koriste u programu. Da biste reproducirali kretanje objekta, prvo morate prikazati objekt u pozadini...

Obrada statističkih podataka u datoteci

Program se sastoji od sljedećih procedura: - procedura - rukovatelj događajima za jedan klik mišem na FileListBox1 komponentu: void __fastcall TForm1::FileListBox1Click(TObject *Sender); -procedura - rukovatelj događajima pri zatvaranju forme: void __fastcall TForm1::FormClose(TObject *Sender...

Program "Kinematsko kretanje"

Algoritam programa prikazan je na slici 4. Ovisno o unesenim podacima program proizvodi potrebne kalkulacije i izvodi animirani zaplet. Ovaj program koristi mnogo različitih funkcija...

Razvijanje pogleda za prikaz uzoraka rezultata

Tijekom projektiranja ovog softverski proizvod Provedena je objektno orijentirana dekompozicija koja je prikazana u tablici 10.1. Tablica 10...

Razvoj programa za optimizaciju rada jednog varijabilna metoda dihotomije

Algoritam: Pretpostavimo da je xn = . Duljina segmenta L = (|B| - |A|). Izračunajmo f(xn). x1 = A + ,x2 = B - . Izračunavamo f(x1) i f(x2). Ako je f(x1)< f(xn), то исключаем интервал , для этого B = xn, xn = x1. Переход к шагу 5. Иначе к шагу 4. Если f(x2) < f(xn), то исключаем интервал для этого A = xn...

U prvom dijaloškom okviru, kada kliknete na gumb "Start", poziva se rukovatelj događajem BN_CLICKED, koji pak kreira objekt klase CMDlg, koja je nasljednica klase CDialog. Nakon toga, pomoću metode DoModal(), poziva se drugi dijaloški prozor...

Razvoj programa za izračunavanje površine trokuta na temelju dviju stranica i kuta između njih

Naziv klase Specifikacija pristupa popisu članova Svrha Cdialog DoModal() public Ova se funkcija poziva za prikaz modalnog dijaloškog okvira. SetDlgItemText(int nID, Cstring str) public Funkcija prosljeđuje tekst dijaloškom elementu...

Implementacija softvera za prikaz rotacije piramide na primjeru središnje projekcije

Kada pokrenete program, pojavljuje se glavni prozor programa (slika 2.1), koji sadrži izbornik, područje pregleda i elemente upravljanja: “Koordinate vektora rotacije”, “Kut rotacije”, “Vrsta gibanja” i akcijske gumbe...

Izrada baze podataka građevinskih tvrtki

Ovaj program uključuje sljedeće module: 1. Glavni modul. 1) otvaranje ostalih modula (jedinica1, jedinica2, jedinica5, jedinica6, jedinica7, jedinica8, jedinica9, jedinica10, jedinica11...

Projektni zadatak za izradu automatizirani sustavi

Glavni program radi u tri načina. Dijagram glavnog programa prikazan je na slici 1. Slika 1 - Dijagram glavnog programa U modusu 1 prikazuje se indeks elementa za koji je zbroj elemenata koji mu prethode...

Elektronički udžbenik preko Festo distribucijske stanice

Program uključuje: · Funkciju za pregled tekstualnih datoteka; · Funkcija pregledavanja slika; · Funkcija prolaska testa. Program je napisan u programskom jeziku Borland Delphi 7 pomoću Borland Delphi 7 kompajlera...

Većina web stranica, posebno onih na besplatnom hostingu, ne pohranjuju "velike" informacije poput filmova, glazbe i igara na svoje prostor na disku. Stranica sadrži samo poveznice s opisima izvora, za čije preuzimanje vlasnik stranice često dobiva nagradu u obliku plaćanja.

Da bi se ova nagrada događala češće, potrebna je velika mašta u smislu opisa resursa, i glavni zadatak opisi - privući korisnika isticanjem ovaj opis od tisuća sličnih.

Na primjer, vrlo je važno ispravni opisi filmova koji će biti objavljeni. Čini se da neki webmasteri imaju ustaljen pristup ovom problemu: na stranici postoji videoplayer, poveznica na poznati teaser, opis filma i njegovi tehnički podaci.

Ali, ako pogledate, ispada da teaser ne sadrži ruski prijevod, opis je preveo Google prevoditelj iz baze podataka IMDB, a tehnički podaci općenito su kopirani s drugih stranica. I koliki će interes pokazati gledatelj kada pogleda opis od 1-2 retka? To zahtijeva temeljitiji rad.

Na potpuno isti način morate pristupiti opisu programa. Na primjer, koja je svrha obavještavati budućeg klijenta o njegovoj verziji ako opis ni na koji način ne implicira da su uopće postojale druge verzije?

Reći da program ima verziju “1.5.6” je ne reći ništa, jer će korisnik, ako ga zanima, svakako otići na Wikipediju ili službenu web stranicu kako bi saznao datum izlaska upravo ove verzije. Ako se pokaže da je svježiji, onda će ga preuzeti sa službeni izvor ili torrent.

Ovdje vrijedi pravilo: kada opisujete program, uvijek napišite datum ažuriranja. Općenito, opis treba biti napisan tako da klijentu nisu potrebne dodatne informacije, već da ga obično zanima sljedeće:

  • Kako se točno zove program?
  • Tko je njegov autor?
  • Je li ovaj program prije bio poznat pod drugim imenom?
  • Plaća li se ili besplatno?
  • Točna ograničenja besplatne verzije.
  • Razlika između ove verzije i prethodne.
  • Stvarne recenzije i problemi povezani s programom.
  • Snimke zaslona programa.
  • Sistemski zahtjevi (minimalni, uobičajeni i preporučeni).
  • Značajke instalacije.
  • Volumen distribucije, veličina instalirane aplikacije.
  • Dostupnost rusifikacije (ugrađena, vanjska). Je li sustav pomoći rusificiran, postoji li forum za podršku na ruskom jeziku, je li moguće pisati službi za podršku na ruskom. Na primjer, isti Avast već se doživljava kao ruski program, no komunikacija s programerima temelji se samo na engleskom jeziku.
  • Koji dodatni dodaci i dodaci mogu biti potrebni korisniku pri radu s programom.
  • Postoje li sukobi s operativnim sustavom ili drugim instaliranim softverom (vatrozidi, uslužni programi za optimizaciju i sigurnost, antivirusi itd.).
  • Zahtijeva li program pristup internetu tijekom instalacije i rada? Isti važna točka, budući da mnogi programi rade kroz sustav opskurnih bootloadera, nametnutih od strane boot managera itd.

Što više opcija opisa pružite, više ćete pažnje privući svom resursu, a to je upravo ono što je bilo potrebno.

Prethodne publikacije:

3. OPIS STRUKTURE PROGRAMA

Opis varijabli

Odjeljak s opisima varijabli opisuje varijable čija je svrha navedena u tablici 3.1.


Tablica 3.1 – Opis programske varijable

Ime Tip Svrha
FO, FS TextFile Varijabla tekstualne datoteke izvora i rezultata
tmpstr,str,strslovo Niz String varijable za čitanje iz datoteke
i J cijeli broj Varijabilni brojači za petlje
računati cijeli broj Varijabla pohranjuje broj ispravljenih znakova
odgovor Riječ Koristi se za određivanje korisnikova odgovora na pitanje o ispravljanju znaka
UpCh set char Puno velikih likova
ZnCh set char Više znakova za razdvajanje riječi
OFName Niz Niz koji sadrži stazu do izvorne datoteke
SFName Niz Niz koji sadrži stazu do rezultirajuće datoteke
Opis pomoćnog postupka

Program sadrži opis jednog pomoćnog postupka.

Procedura Output FormCreate početne vrijednosti u komponente obrasca za ispravan prikaz obrasca na početku programa.

Button1Click postupak za otvaranje izvorna datoteka i održavanje puta do njega.

Postupak Button2Click za otvaranje rezultirajuće datoteke i spremanje putanje do nje.

Glavni programski algoritam

Algoritam za izvođenje glavnog dijela programa prikazan je na slici A.1 u Dodatku A. Dakle, u postupku, prije svega, datoteka se veže na varijablu datoteke i tekstualna datoteka se otvara za čitanje tekstualne informacije.

Zatim se informacije čitaju iz datoteke red po red.

Zatim su riječi u svakom retku istaknute.

Zatim se odabrane riječi traže za velika slova.

Zatim se promjene zapisuju u rezultirajuću tekstualnu datoteku.

Tijekom rada korištene su sljedeće operacije s tekstualnim datotekama:

Dodijeli datoteku(<Имя файловой переменной>,<Имя файла>);

Naziv datoteke naveden je kao konstanta niza ili putem varijabla tipa Ubosti. Naziv datoteke mora biti u skladu s pravilima operativnog sustava. ovaj trenutak operacijski sustav. Ako je niz imena prazan, tada je varijabla datoteke pridružena standardni uređaj I/O

Poništi (<Имя файловой переменной>);

Datoteka se otvara kako bi se iz nje pročitale informacije i dodjeljuje joj se ime određeno postupkom Assign.

Nakon rada s datotekom, obično je treba zatvoriti pomoću procedure CloseFile (<Имя файловой переменной>). Informacije ispisuje operator WRITELN(f: TextFile;S: String). Nakon njegovog izvršenja, niz S se dodaje na kraj datoteke pridružene varijabli f.

4. OPIS ULAZNIH PODATAKA

Ulazni podatak za izvođenje je datoteka koja sadrži velika slova.

5. OPIS IZLAZNIH PODATAKA

Izlaz je:

Poruka o završetku provjere datoteke za prisutnost velikih znakova;

Poruka o broju ispravljenih znakova;

Dovršena rezultirajuća tekstualna datoteka.

6. UPUTE ZA OPERATERA

Razvijeni program je izvršna datoteka Luchshev.exe je veličine 405 KB. Program implementira algoritam za provjeru tekstualne datoteke za prisutnost velikih znakova.

Nakon pokretanja programa pojavljuje se prozor prikazan na slici 4.1.

Slika 4.1 – Glavni prozor programa

Nakon toga korisnik mora navesti put do datoteke. Slika 4.2 prikazuje primjer dijaloškog okvira za otvaranje datoteke.


Slika 4.2 – Primjer otvaranja izvorne datoteke

Primjer poruke o pronalasku velikog slova prikazan je na slici 4.3.

Slika 4.3 – Poruka o pronalaženju velikog slova

Primjer prozora s rezultatom provjere tekstualne datoteke prikazan je na slici 4.4.


Slika 4.4 - Rezultirajući prozor.

Rezultat provjere zapisuje se u odabranu datoteku rezultata koja se nalazi u odabranom direktoriju.

Funkcioniranje programa u potpunosti odgovara zadatku.


Ovaj rad je završen u potpunosti u skladu sa postavljenim zadatkom i otklonjen je u Delphi okruženje 7.0. U nastajanju predmetni rad Razvijen je program za provjeru tekstualne datoteke.

Tijekom kolegijalnog projekta provedena je analiza projektni zadatak i formulacija problema dizajna.

Istaknute su funkcije koje bi razvijeni program trebao imati.

Za izvođenje generiranih funkcija razvijen je programski algoritam.

Prema razvijenom algoritmu sastavljen je program u algoritamskom jeziku i otklonjene su pogreške Delphi programiranje. Tijekom razvoja programa, testiran je i otklanjane su pogreške ispitni setovi. Za pisani program razvijena je uputa operatera koja ukazuje na redoslijed radnji koje treba izvesti.

Rezultati rada prikazani su u obliku obrazloženja.

Tijekom izrade programa učvršćene su sljedeće radne vještine:

I/O naredbe i za ekran i za tekstualne datoteke,

Korištenje postupaka

Naredbe za obradu polja

Naredbe za implementaciju petlji sa dati broj ponavljanja;

Naredbe za provjeru uvjeta i provedbu grananja.

Kao rezultat završetka ovog kolegija, uvjerili smo se u široke mogućnosti Programski jezik Delphi, ojačane praktične vještine programiranja u Delphi okruženju.


Popis poveznica

1. Zuev E.A. Programiranje u Delphiju 6.0,7.0. – M.: Radio i veze, Vesta, 1993.

2. Faronov V.V. Delphi 7.0. Početni tečaj. - M.: Znanje, 2000.


DODATAK A

Programski algoritam

Slika A.1 – Algoritam programa


Slika A.2 – Algoritam postupka glavnog programa


DODATAK B

Popis programa

4. Windows, Poruke, SysUtils, Variants, Classes, Graphics, Controls, Forms,

5. Dijalozi, StdCtrls;

7. TForm1 = klasa(TForm)

8. Gumb1: TButton;

9. Gumb2: TButton;

10. OpenDialog1: TOpenDialog;

11. SaveDialog1: TSaveDialog;

12. Gumb3: TButton;

13. Oznaka1: TLabel;

14. Oznaka2: TLabel;

15. Oznaka3: TLabel;

16. Oznaka4: TLabel;

17. Gumb4: TButton;

18. procedure Button1Click(Sender: TObject);

19. procedure Button2Click(Sender: TObject);

20. procedure FormCreate(Sender: TObject);

21. procedure Button3Click(Sender: TObject);

22. procedure Button4Click(Sender: TObject);

24. (Privatne izjave)

26. (Javne izjave)

29. Obrazac1: TObrazac1;

30. OFName,SFName:String;

31.provedba

33. procedure TForm1.Button1Click(Sender: TObject);

35. if OpenDialog1.Execute then

36. OFName:=OpenDialog1.FileName;

37. ako je OFName<>"" zatim počnite

38. Button1.Enabled:=False;

39. Button2.Visible:=True;

40. Label1.Caption:="Put do datoteke za provjeru: "+OFName;

41. Label2.Visible:=True;

45. procedure TForm1.Button2Click(Sender: TObject);

50. if SaveDialog1.Execute then

51. SFName:=SaveDialog1.FileName;

52. if Pos(".txt",SFName)=0 then SFName:=SFName+".txt";

53. if SFName=OFName then

54. ShowMessage("Odaberi drugu datoteku za spremanje rezultata")

57. ako (SFName<>"") i (b) zatim počnite

58. Button2.Enabled:=False;

59. Label2.Caption:="Put do rezultirajuće datoteke: "+SFName;

60. Button3.Visible:=True;

61. Label3.Visible:=True;

62. Label3.Caption:="Za početak provjere kliknite na gumb "Provjeri"";

65. procedure TForm1.FormCreate(Sender: TObject);

67. Button2.Visible:=False;

68. Label2.Visible:=False;

69. Button3.Visible:=False;

70. Label3.Visible:=False;

71. Button4.Visible:=False;

72. Label4.Visible:=False;

73. Label1.Caption:="Kliknite na gumb "Otvori" i odaberite datoteku za provjeru";

75. procedure TForm1.Button3Click(Sender: TObject);

77.FO,FS:Tekstualna datoteka;

78. i,j,count:cijeli broj;

79. str,strslovo,tmpstr:String;

80. ZnCh,UpCh: skup Char;

84. ZnCh:=[".",",",","!","?"];

85. UpCh:=["A".."Z","A".."Z"];

86. DodijeliDatoteku(FO,OFName);

87. DodijeliDatoteku(FS,SFName);

91. ako IOResult<>0 zatim počnite

92. ShowMessage("Došlo je do problema prilikom otvaranja datoteke. Program će biti prekinut");

96.Prepiši(FS);

97. dok ne Eof(FO) ne počinju

98. Readln(FO,str);

99. strslovo:="";

100. za i:=1 do Length(str) do start

101. if (str[i] u ZnCh) ili (str[i]=" ") tada počni

102. za j:=1 do Length(strslovo) do start

a. ako strslovo[j] u UpCh tada počni

b. answ:=MessageDlg("Veliko slovo ""+strslovo[j]+" pronađeno je u riječi ""+strslovo+"". Zamijeniti ga malim?",mtInformation,,0);

c. ako je odgovor=mrDa, počnite

ja tmpstr:=strslovo[j];

ii. tmpstr:=AnsiLowerCase(tmpstr);

iii. Brisanje(strslovo,j,1);

iv. Umetni(tmpstr,strslovo,j);

104. Write(FS,strslovo+str[i]);

105. strslovo:="";

108. strslovo:=strslovo+str[i];

110. Writeln(FS,"");

112. Zatvori datoteku (FO);

113. Zatvori datoteku(FS);

114. Label3.Caption:="Provjera datoteke dovršena. Popravljeno "+IntToStr(count)+" velika slova.";

115. Button3.Enabled:=False;

116. Button4.Visible:=True;

117. Label4.Visible:=True;

120. procedure TForm1.Button4Click(Sender: TObject);

122. OFName:="";

123.SFName:="";

124. Button1.Enabled:=True;

125. Button2.Visible:=False;

126. Button2.Enabled:=True;

127. Button3.Visible:=False;

128. Button3.Enabled:=True;

129. Button4.Visible:=False;

130. Label2.Visible:=False;

131. Label3.Visible:=False;

132. Label4.Visible:=False;

133. Label1.Caption:="Kliknite na gumb "Otvori" i odaberite datoteku za provjeru";


DODATAK B

Rezultati rješenja programa