Halimbawang paglalarawan ng programa ayon sa GOST. Young fighter course: Sa paghahanda ng dokumentasyon ng programa (dokumentasyon). Anong mga function ang ginagawa ng iyong application?

Ang dokumentong ito ay tumutukoy sa software-operational na uri. Nalalapat sa isang program, complex, software package, software component o system.
Target na madla: mga taong gumagawa ng mga desisyon tungkol sa pagbili at pagkomisyon ng programa. Ang dokumento ay naglalaman ng impormasyon tungkol sa functionality programa at saklaw nito.

Mga GOST at pamantayan

Ang istraktura at disenyo ng dokumento ay tinutukoy sa.
Bahagi ng impormasyon(mga anotasyon at nilalaman) alinsunod sa.

Sa anong mga kaso ito ay kinakailangan

Ang dokumento ay kinakailangan upang ipaalam sa mga potensyal na gumagamit at mamimili tungkol sa layunin ng programa at mga pamamaraan ng aplikasyon. Mas angkop para sa mga tagapamahala (mga espesyalista, mga tagapangasiwa ng system), na nakapag-iisa na nagpasya na bilhin ang programa at isakatuparan ito.

Makukuha nila ang lahat ng kinakailangang impormasyon mula sa dokumentong ito: isang paglalarawan ng programa at ang aplikasyon nito.

Ang paglalarawan ng programa at paglalarawan ng aplikasyon ay nagpapahiwatig ng:

Mga problema na nalulutas ng programa;
Mga mapagkukunang ginagastos para sa trabaho;
Panimulang impormasyon;
Output data.

Ang diin ay nasa naglalarawang bahagi ng programa, ang mga tungkulin at layunin nito. Sa mas mababang lawak sa paglalarawan ng aplikasyon. Ang isang paglalarawan ay partikular na ginawa tungkol sa mga kakayahan ng programa at ang mga problemang nalulutas nito, at hindi tungkol dito panloob na istraktura. Sa ilang partikular na feature ng programa, posibleng pagsamahin ang mga seksyon o ipakilala ang mga bago (karagdagan).

Istraktura ng paglalarawan ng programa (GOST 19.402-78):

1. Pangkalahatang impormasyon.
2. Functional na layunin mga programa.
3. Paglalarawan ng lohikal na istraktura.
4. Teknikal na paraan, na ginagamit.
5. Tumawag at mag-download.
6. Input ang data.
7. Itatak.

Istraktura ng paglalarawan ng aplikasyon (GOST 19.502-78):

1. Layunin ng programa.
2. Kondisyon ng paggamit.
3. Deskriptibong bahagi ng gawain.
4. Data ng input at output.
5. mga aplikasyon (talahanayan, ilustrasyon, atbp.).

Maaari kang mag-order ng pagbuo ng isang dokumento o kumpletong set dokumentasyon ng software.

Automation ng mga proseso ng library

Dokumentasyon ng database na "Listahan ng mga may-ari ng kooperatiba ng garahe"

Ang database ng "Listahan ng Mga May-ari ng Kooperatiba ng Garage" ay binubuo ng tatlong anyo. Ang pangunahing talahanayan ay nilikha gamit ang gamit ang Access. ang unang form ay naglalaman ng mga sumusunod na elemento: Data (para sa komunikasyon sa mga Access table gamit ang DatabaseName at DataSource properties)...

Sistema ng impormasyon at sanggunian "Kontrol sa gawain ng mga tagataguyod"

Catalog ng mga produktong elektrikal

Ang programa ay binubuo ng tatlong anyo. Ang unang form ay may Password para sa program na ito. Ang form ay may nakapirming laki. Naglalaman ito ng text field (TextBox) kung saan ang user ay nagpasok ng password, pati na rin ang isang button (CommandButton)...

Pagsusulat laro sa kompyuter"Ibaril ang Eroplano"

Sa programa, ang pangunahing gawain ay ginagampanan ng animation. Pinapayagan ka nitong ipatupad ang paggalaw ng lahat ng mga bagay na ginamit sa programa. Upang kopyahin ang paggalaw ng isang bagay, kailangan mo munang ipakita ang bagay laban sa background...

Pagproseso ng istatistikal na data sa isang file

Ang programa ay binubuo ng mga sumusunod na pamamaraan: - procedure - event handler para sa isang click ng mouse sa FileListBox1 component: void __fastcall TForm1::FileListBox1Click(TObject *Sender); -procedure - event handler kapag nagsasara ng form: void __fastcall TForm1::FormClose(TObject *Sender...

Programa na "Kinematic motion"

Ang algorithm ng programa ay ipinakita sa Figure 4. Depende sa ipinasok na data, ang programa ay gumagawa mga kinakailangang kalkulasyon at gumaganap ng animated plotting. Gumagamit ang program na ito ng maraming iba't ibang function...

Pagbuo ng mga view upang ipakita ang mga sample na resulta

Sa panahon ng disenyo nito produkto ng software Ang isang object-oriented na agnas ay isinagawa, na ipinakita sa Talahanayan 10.1. Talahanayan 10...

Pagbuo ng isang programa upang ma-optimize ang paggana ng isa variable na paraan dichotomies

Algorithm: Ipagpalagay natin na xn = . Haba ng segment L = (|B| - |A|). Kalkulahin natin ang f(xn). x1 = A + ,x2 = B - . Kinakalkula namin ang f(x1) at f(x2). Kung f(x1)< f(xn), то исключаем интервал , для этого B = xn, xn = x1. Переход к шагу 5. Иначе к шагу 4. Если f(x2) < f(xn), то исключаем интервал для этого A = xn...

Sa unang dialog box, kapag nag-click ka sa "Start" na buton, ang BN_CLICKED event handler ay tinatawag, na lumilikha naman ng object ng CMDlg class, na isang inheritor ng CDialog class. Pagkatapos nito, gamit ang DoModal() na pamamaraan, ang pangalawang dialog window ay tinatawag na...

Pag-unlad ng isang programa para sa pagkalkula ng lugar ng isang tatsulok batay sa dalawang panig at ang anggulo sa pagitan nila

Pangalan ng Klase Listahan ng Miyembro Access Detalye Layunin Cdialog DoModal() public Tinatawag ang function na ito upang magpakita ng modal dialog box. SetDlgItemText(int nID, Cstring str) public Ipinapasa ng function ang teksto sa elemento ng dialogo...

Pagpapatupad ng software para sa paglalarawan ng pag-ikot ng isang pyramid gamit ang halimbawa ng isang sentral na projection

Kapag sinimulan mo ang programa, lilitaw ang pangunahing window ng programa (Figure 2.1), na naglalaman ng isang menu, lugar ng pagtingin, at mga elemento ng kontrol: "Mga coordinate ng vector ng pag-ikot", "Anggulo ng pag-ikot", "Uri ng paggalaw" at mga pindutan ng pagkilos...

Paglikha ng database ng kumpanya ng konstruksiyon

Kasama sa programang ito ang mga sumusunod na modyul: 1. Pangunahing modyul. 1) pagbubukas ng iba pang mga module (unit1, unit2, unit5, unit6, unit7, unit8, unit9, unit10, unit11...

Mga tuntunin ng sanggunian para sa paglikha mga awtomatikong sistema

Ang pangunahing programa ay nagpapatakbo sa tatlong mga mode. Ang diagram ng pangunahing programa ay ipinakita sa Figure 1. Figure 1 - Diagram ng pangunahing programa Sa mode 1, ang index ng elemento ay ipinapakita kung saan ang kabuuan ng mga elemento na nauuna dito...

Elektronikong aklat-aralin sa pamamagitan ng Festo distribution station

Ang programa ay kinabibilangan ng: · Function para sa pagtingin ng mga text file; · Pag-andar ng pagtingin sa imahe; · Test pagpasa function. Ang programa ay nakasulat sa Borland Delphi 7 programming language gamit ang Borland Delphi 7 compiler...

Karamihan sa mga site, lalo na ang mga nasa libreng pagho-host, ay hindi nag-iimbak ng "malaking" impormasyon tulad ng mga pelikula, musika at mga laro sa kanilang espasyo sa disk. Ang site ay naglalaman lamang ng mga link na may mga paglalarawan ng mga mapagkukunan, para sa pag-download kung saan ang may-ari ng site ay madalas na nakakatanggap ng gantimpala sa anyo ng pagbabayad.

Para mas madalas mangyari ang gantimpala na ito, kailangan ng malaking imahinasyon sa mga tuntunin ng paglalarawan ng mapagkukunan, at pangunahing gawain paglalarawan - akitin ang gumagamit sa pamamagitan ng pag-highlight paglalarawang ito sa libu-libong katulad.

Halimbawa, ito ay napakahalaga tamang paglalarawan mga pelikulang malapit nang ipalabas. Ang ilang mga webmaster ay tila may itinatag na diskarte sa problemang ito: mayroong isang video player sa site, isang link sa isang sikat na teaser, isang paglalarawan ng pelikula at ang teknikal na data nito.

Ngunit, kung titingnan mo, lumalabas na ang teaser ay hindi naglalaman ng isang pagsasalin ng Ruso, ang paglalarawan ay isinalin ng Google translator mula sa database ng IMDB, at ang teknikal na data ay karaniwang kinopya mula sa iba pang mga site. At gaano karaming interes ang ipapakita ng manonood kapag tumitingin sa isang paglalarawan ng 1-2 linya? Nangangailangan ito ng mas masusing gawain.

Kailangan mong lapitan ang paglalarawan ng mga programa sa eksaktong parehong paraan. Halimbawa, ano ang silbi ng pag-abiso sa isang kliyente sa hinaharap tungkol sa bersyon nito kung ang paglalarawan sa anumang paraan ay hindi nagpapahiwatig na may iba pang mga bersyon?

Upang sabihin na ang programa ay may bersyon na "1.5.6" ay walang sasabihin, dahil ang gumagamit, kung interesado, ay tiyak na pupunta sa Wikipedia o sa opisyal na website upang mahanap ang petsa ng paglabas ng mismong bersyon na ito. Kung ito ay lumabas na mas sariwa, pagkatapos ay ida-download niya ito mula sa opisyal na mapagkukunan o torrent.

Narito ang panuntunan: kapag naglalarawan ng isang programa, palaging isulat ang petsa ng pag-update. Sa pangkalahatan, ang paglalarawan ay dapat na nakasulat sa paraang ang kliyente ay hindi nangangailangan ng karagdagang impormasyon, ngunit karaniwang interesado sa mga sumusunod:

  • Ano nga ba ang pangalan ng programa?
  • Sino ang may akda nito?
  • Nakilala ba ang program na ito dati sa ilalim ng ibang pangalan?
  • May bayad ba ito o libre?
  • Mga eksaktong limitasyon ng libreng bersyon.
  • Ang pagkakaiba sa pagitan ng bersyong ito at ng nauna.
  • Mga totoong pagsusuri at problemang nauugnay sa programa.
  • Mga screenshot ng programa.
  • Mga kinakailangan sa system (minimum, karaniwan at inirerekomenda).
  • Mga tampok ng pag-install.
  • Dami ng pamamahagi, laki ng naka-install na application.
  • Availability ng Russification (built-in, external). Russified ba ang sistema ng tulong, mayroon bang forum ng suporta sa wikang Ruso, posible bang sumulat sa serbisyo ng suporta sa Russian. Halimbawa, ang parehong Avast ay nakikita na bilang programang Ruso, ngunit ang komunikasyon sa mga developer ay nakabatay lamang sa wikang Ingles.
  • Anong mga karagdagang addon at add-on ang maaaring kailanganin ng user kapag nagtatrabaho sa program.
  • Mayroon bang anumang mga salungatan sa operating system o iba pang naka-install na software (mga firewall, optimization at security utilities, antivirus, atbp.).
  • Nangangailangan ba ang programa ng access sa Internet sa panahon ng pag-install at pagpapatakbo? Pareho mahalagang punto, dahil maraming mga programa ang gumagana sa pamamagitan ng isang sistema ng mga hindi kilalang bootloader, na ipinataw ng mga boot manager, atbp.

Kung mas maraming opsyon sa paglalarawan ang ibibigay mo, mas maraming atensyon ang maaakit mo sa iyong mapagkukunan, at ito mismo ang kinakailangan.

Mga nakaraang publikasyon:

3. PAGLALARAWAN NG ISTRUKTURA NG PROGRAMA

Paglalarawan ng mga Variable

Ang seksyon ng mga paglalarawan ng variable ay naglalarawan ng mga variable na ang layunin ay ibinigay sa Talahanayan 3.1.


Talahanayan 3.1 – Paglalarawan mga variable ng programa

Pangalan Uri Layunin
FO,FS TextFile Variable ng text file ng pinagmulan at resulta
tmpstr,str,strslovo String String variable para sa pagbabasa mula sa isang file
ako, j integer Mga variable na counter para sa mga loop
bilangin integer Iniimbak ng variable ang bilang ng mga naitama na character
sagot salita Ginagamit upang matukoy ang sagot ng user sa isang tanong tungkol sa pagwawasto ng isang character
UpCh set ng char Maraming capital characters
ZnCh set ng char Maramihang mga character ng separator ng salita
OFName String Isang string na naglalaman ng path sa source file
SFName String Isang string na naglalaman ng path sa resultang file
Paglalarawan ng pantulong na pamamaraan

Ang programa ay naglalaman ng isang paglalarawan ng isang pantulong na pamamaraan.

Output FormCreate na pamamaraan mga paunang halaga sa mga bahagi ng form para sa tamang pagpapakita ng form sa simula ng programa.

Button1Click na pamamaraan para sa pagbubukas source file at pagpapanatili ng landas patungo dito.

Ang pamamaraan ng Button2Click para sa pagbubukas ng resultang file at pag-save ng landas patungo dito.

Algorithm ng pangunahing programa

Ang algorithm para sa pagpapatupad ng pangunahing katawan ng programa ay ipinapakita sa Figure A.1 sa Appendix A. Kaya sa pamamaraan, una sa lahat, ang file ay nakatali sa isang variable ng file at ang text file ay binuksan para sa pagbabasa impormasyon sa teksto.

Pagkatapos ay binabasa ang impormasyon mula sa file sa bawat linya.

Pagkatapos ang mga salita sa bawat linya ay naka-highlight.

Pagkatapos ay hahanapin ang mga napiling salita para sa mga malalaking character.

Pagkatapos ay isusulat ang mga pagbabago sa nagresultang text file.

Sa panahon ng trabaho, ang mga sumusunod na operasyon na may mga text file ay ginamit:

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

Ang pangalan ng file ay tinukoy bilang isang string constant o sa pamamagitan ng uri ng variable Masakit. Ang pangalan ng file ay dapat sumunod sa mga patakaran ng operating system. sa ngayon operating system. Kung walang laman ang string ng pangalan, nauugnay ang variable ng file sa karaniwang aparato I/O

I-reset (<Имя файловой переменной>);

Binuksan ang isang file upang basahin ang impormasyon mula dito, at itinalaga ang pangalang tinukoy ng pamamaraan ng Italaga.

Pagkatapos magtrabaho sa isang file, dapat itong sarado gamit ang CloseFile procedure (<Имя файловой переменной>). Ang impormasyon ay output ng WRITELN(f: TextFile;S: String) operator. Pagkatapos ng pagpapatupad nito, ang string S ay idinagdag sa dulo ng file na nauugnay sa variable na f.

4. PAGLALARAWAN NG INPUT DATA

Ang input data para sa pagpapatupad ay isang file na naglalaman ng mga malalaking titik.

5. PAGLALARAWAN NG OUTPUT DATA

Ang output ay:

Isang mensahe tungkol sa pagkumpleto ng pagsuri sa file para sa pagkakaroon ng mga capital character;

Mensahe tungkol sa bilang ng mga naitama na character;

Ang nakumpletong resultang text file.

6. MGA INSTRUKSYON NG OPERATOR

Ang binuong programa ay maipapatupad na file Ang Luchshev.exe ay 405 KB ang laki. Ang programa ay nagpapatupad ng isang algorithm para sa pagsuri ng isang text file para sa pagkakaroon ng mga capital character.

Pagkatapos simulan ang programa, lilitaw ang window na ipinapakita sa Figure 4.1.

Figure 4.1 – Pangunahing window ng programa

Pagkatapos nito, dapat tukuyin ng user ang landas patungo sa file. Ang Figure 4.2 ay nagpapakita ng isang halimbawa ng isang dialog box para sa pagbubukas ng isang file.


Figure 4.2 – Halimbawa ng pagbubukas ng source file

Ang isang halimbawa ng isang mensahe tungkol sa paghahanap ng isang malaking karakter ay ipinapakita sa Figure 4.3.

Figure 4.3 – Mensahe tungkol sa paghahanap ng isang capital character

Ang isang halimbawa ng isang window na may resulta ng pagsuri sa isang text file ay ipinapakita sa Figure 4.4.


Figure 4.4 - Resultang window.

Ang resulta ng tseke ay nakasulat sa napiling file ng resulta na matatagpuan sa napiling direktoryo.

Ang paggana ng programa ay ganap na tumutugma sa gawain.


Ang gawaing kursong ito ay nakumpleto nang buong alinsunod sa itinalagang gawain at na-debug kapaligiran ng Delphi 7.0. Isinasagawa gawaing kurso Ang isang programa ay binuo upang suriin ang isang text file.

Sa panahon ng proyekto ng kurso, isang pagsusuri ang isinagawa tuntunin ng sanggunian at pagbabalangkas ng problema sa disenyo.

Na-highlight ang mga function na dapat mayroon ang binuong programa.

Ang isang algorithm ng programa ay binuo upang maisagawa ang mga nabuong function.

Ayon sa binuo na algorithm, ang isang programa sa algorithmic na wika ay pinagsama-sama at na-debug Delphi programming. Sa panahon ng pagbuo ng programa, ito ay sinubukan at na-debug mga set ng pagsubok. Para sa nakasulat na programa, ang mga tagubilin ng operator ay binuo na nagpapahiwatig ng pagkakasunud-sunod ng mga aksyon na isasagawa.

Ang mga resulta ng trabaho ay ipinakita sa anyo ng isang paliwanag na tala.

Sa panahon ng pagbuo ng programa, ang mga sumusunod na kasanayan sa trabaho ay pinagsama-sama:

I/O commands pareho sa screen at sa mga text file,

Paggamit ng mga pamamaraan

Array processing commands

Mga utos para sa pagpapatupad ng mga loop na may binigay na numero pag-uulit;

Mga utos para sa pagsuri sa mga kondisyon at pagpapatupad ng mga sangay.

Bilang resulta ng pagkumpleto ng gawaing kursong ito, nakumbinsi kami malawak na posibilidad Delphi programming language, pinalakas ang praktikal na mga kasanayan sa programming sa kapaligiran ng Delphi.


Listahan ng mga link

1. Zuev E.A. Programming sa Delphi 6.0,7.0. – M.: Radyo at mga komunikasyon, Vesta, 1993.

2. Faronov V.V. Delphi 7.0. Beginner course. - M.: Kaalaman, 2000.


APENDIKS A

Algoritmo ng programa

Figure A.1 – Algoritmo ng programa


Figure A.2 – Algorithm ng pangunahing pamamaraan ng programa


APENDIKS B

Listahan ng programa

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

5. Mga Dialog, StdCtrls;

7. TForm1 = klase(TForm)

8. Button1: TButton;

9. Button2: TButton;

10. OpenDialog1: TOpenDialog;

11. SaveDialog1: TSaveDialog;

12. Button3: TButton;

13. Label1: TLabel;

14. Label2: TLabel;

15. Label3: TLabel;

16. Label4: TLabel;

17. Button4: 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. (Mga pribadong deklarasyon)

26. (Mga pampublikong deklarasyon)

29. Form1: TForm1;

30. OFName,SFName:String;

31.pagpapatupad

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

35. kung OpenDialog1.Ipatupad pagkatapos

36. OFName:=OpenDialog1.FileName;

37. kung OFName<>"" pagkatapos ay magsimula

38. Button1.Enabled:=False;

39. Button2.Visible:=Totoo;

40. Label1.Caption:="Path to the file to check: "+OFName;

41. Label2.Visible:=Totoo;

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

50. kung SaveDialog1.Ipatupad pagkatapos

51. SFName:=SaveDialog1.FileName;

52. kung Pos(".txt",SFName)=0 pagkatapos ay SFName:=SFName+".txt";

53. kung SFName=OFName noon

54. ShowMessage("Pumili ng isa pang file para i-save ang resulta")

57. kung (SFName<>"") at (b) pagkatapos ay magsimula

58. Button2.Enabled:=False;

59. Label2.Caption:="Path sa resultang file: "+SFName;

60. Button3.Visible:=Totoo;

61. Label3.Visible:=Totoo;

62. Label3.Caption:="Upang simulan ang pagsuri, mag-click sa "Check" na buton";

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

67. Button2.Visible:=Mali;

68. Label2.Visible:=Mali;

69. Button3.Visible:=Mali;

70. Label3.Visible:=Mali;

71. Button4.Visible:=Mali;

72. Label4.Visible:=Mali;

73. Label1.Caption:="I-click ang "Buksan" na buton at piliin ang file na susuriin";

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

77.FO,FS:TextFile;

78. i,j,count:integer;

79. str,strslovo,tmpstr:String;

80. ZnCh,UpCh:set ng Char;

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

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

86. AssignFile(FO,OFName);

87. AssignFile(FS,SFName);

91. kung IORresult<>0 pagkatapos magsimula

92. ShowMessage("May mga problema sa pagbubukas ng file. Tatapusin ang programa");

96.Muling Isulat(FS);

97. habang hindi nagsisimula ang Eof(FO).

98. Readln(FO,str);

99. strslovo:="";

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

101. kung (str[i] sa ZnCh) o (str[i]=" ") pagkatapos ay magsimula

102. para sa j:=1 hanggang Haba(strslovo) magsisimula

a. kung strslovo[j] sa UpCh pagkatapos ay magsimula

b. answ:=MessageDlg("Ang malaking titik na ""+strslovo[j]+" ay natagpuan sa salitang ""+strslovo+"". Palitan ito ng maliit?",mtInformation,,0);

c. kung answ=mrYes pagkatapos ay magsimula

i. tmpstr:=strslovo[j];

ii. tmpstr:=AnsiLowerCase(tmpstr);

iii. Tanggalin(strslovo,j,1);

iv. Ipasok(tmpstr,strslovo,j);

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

105. strslovo:="";

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

110. Writeln(FS,"");

112. CloseFile(FO);

113. CloseFile(FS);

114. Label3.Caption:="Nakumpleto ang pag-verify ng file. Inayos ang "+IntToStr(count)+" malaking titik.";

115. Button3.Enabled:=False;

116. Button4.Visible:=Totoo;

117. Label4.Visible:=Totoo;

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

122. OFName:="";

123. SFName:="";

124. Button1.Enabled:=True;

125. Button2.Visible:=Mali;

126. Button2.Enabled:=Totoo;

127. Button3.Visible:=Mali;

128. Button3.Enabled:=Totoo;

129. Button4.Visible:=Mali;

130. Label2.Visible:=Mali;

131. Label3.Visible:=Mali;

132. Label4.Visible:=Mali;

133. Label1.Caption:="I-click ang "Buksan" na buton at piliin ang file na susuriin";


APENDIKS B

Mga resulta ng solusyon sa programa