Če programska oprema poleg uporabe in konfiguracije omogoča pisanje, urejanje ali uporabo programske kode. Kateri dokument je potreben v tem primeru?

Naloga vodnika za programerje

Programerski priročnik se nanaša na operativno in tehnično dokumentacijo in je potreben v primerih, ko sistem na tak ali drugačen način omogoča pisanje, urejanje ali uporabo programske kode.

Primeri vključujejo:

– knjižnica funkcij;

– platforma ali okolje za razvoj programske opreme;

– Odprtokodna programska oprema.

Dokument mora vsebovati vse potrebne informacije, da lahko razvijalec izkoristi zmogljivosti sistema. Za rešitev te težave lahko vsebina dokumenta vključuje:

– namen, struktura vhodnih in izhodnih podatkov programskih funkcij;

– zmožnosti ustvarjanja programske kode, značilnosti njene interpretacije in prevajanja;

– sintaktične značilnosti uporabljenega programskega jezika;

– morebitna pravila in omejitve pri delu s programsko kodo;

– različna navodila za delo s programom.

Seznam možnih tem ni omejen na to, vse je odvisno od značilnosti določenega sistema. Povedati je treba, da je programerski priročnik lahko zelo koristen za razvijalce sistemov, saj služi kot referenca za trenutno izvedbo logike delovanja programske opreme.

Sestava standardnega programerskega priročnika

V skladu z zahtevami GOST mora programerski priročnik vsebovati naslednje razdelke:

– Namen in pogoji uporabe programa, kjer navajajo obseg programske opreme in tehnične zahteve, potrebne za njeno delovanje.

– Značilnosti programa, kjer opisujejo način delovanja programa, njegove kazalnike hitrosti in druge lastnosti, pomembne za uporabo.

– Dostop do programa, kjer navajajo metode in parametre za zagon programa;

– Vhodni in izhodni podatki, kjer opisujejo obliko, način organizacije in druge zahteve za vhodne in izhodne podatke;

– Sporočila, ki zagotavlja besedila sporočil, ki jih izda program v različnih situacijah, in dejanja, ki jih je treba izvesti.

V prilogah k dokumentu je priporočljivo navesti različne primere, ilustracije in tabele.

Standardi Navodila za programerje

GOST ureja tudi ta dokument, v tem primeru je to GOST 19.504. V skladu z njo sta določeni struktura in vsebina Navodila za programerje.

Stroški razvoja programerskega priročnika

Delo pri izdelavi programerskega priročnika zahteva visoko usposobljene strokovnjake in znanje s področja programiranja, vendar se za profesionalne razvijalce takšno delo običajno zdi dolgočasno in dolgočasno, poleg tega zahteva sposobnost kompetentnega oblikovanja in jasnega prenosa gradiva. Strokovnjaki TechRightConsult imajo bogate izkušnje na obeh področjih, kar nam omogoča izdelavo dokumentov po ugodni ceni in v roku!

Pošljite svoje dobro delo v bazo znanja je preprosto. Uporabite spodnji obrazec

Študenti, podiplomski študenti, mladi znanstveniki, ki bazo znanja uporabljajo pri študiju in delu, vam bodo zelo hvaležni.

Objavljeno na http://www.allbest.ru/

Programerski vodnik

• 1. Namen in pogoji uporabe
• 2. Značilnosti programa
• 3. Dostop do programa
• 4. Celoten seznam modulov in komponent
• 5. Sporočilo uporabniku

1 . Namen in pogoji uporabe

Ta programski izdelek se lahko uporablja neposredno za izvajanje dejavnosti v organizaciji Prof&Elite, ki se ukvarja z montažo plastičnih konstrukcij, vključno z okni. programska oprema plastično okno

Programski produkt Prof&Elite se uporablja za zbiranje podatkov o naročnikih, zaposlenih ter merskih podatkov za izdelavo in proizvodnjo izdelkov. Omogoča centralizirano shranjevanje podatkov. Izdelek ima preprost in intuitiven vmesnik, tako da uporabnik ne bo imel težav z obvladovanjem.

Zasnova tega programskega izdelka bo pomagala avtomatizirati delo upravitelja odnosov s trgovci.

Zahteve glede strojne opreme:

· Intel Pentium procesor IV in višje;

· RAM 512 MB in več;

· video kartica AGP/PCI Express 64 MB ali več;

· prosti prostor na disku 12 MB;

· video monitor z ločljivostjo 1024x768;

· tipkovnica;

· miška;

· tiskalnik za izpis poročil;

· operacijski sistem Windows 98/2000/XP/Vista/7/8;

· Microsoft Access, Borland Delphi 7.

2 . Značilnosti programa

V testnem načinu je bila izvedena zahteva v I/O obrazcu in podatki so bili vneseni v glavno tabelo, kar je omogočilo vizualno oceno obremenitve centralne procesne enote (CPE) in uporabe dodeljenega (virtualnega) pomnilnika z uporabo »Upravitelj opravil«, kot je prikazano na sliki B.1 in sliki B.2.

Slika B.2 – Dodeljeni pomnilnik in čas nalaganja

3 . Dostop do programa

Aplikacijo lahko zaženete s klikom na ikono samega programa, ki se nahaja v posebnem imeniku. Po zagonu aplikacije se na zaslonu prikaže glavno okno, prek katerega lahko upravljate vse funkcije aplikacije, opisane v 4. poglavju tega uporabniškega priročnika.

Ta program lahko zaženete neposredno prek lupine Delphi. Če želite to narediti, morate odpreti projektno datoteko Project1.dbr, ki se nahaja v imeniku s programom. Nato pritisnite F9, da prevedete in zaženete aplikacijo.

Program je mogoče zagnati prek ukazne vrstice. Zaženite ukazno vrstico “Start/All Programs/Accessories/Command Prompt” Nato morate v ukazno vrstico vnesti celotno pot do programa, nato napisati ime programa (Project1.exe) in pritisniti Enter. Program se je začel.

Drug način za zagon programa: v meniju Start izberite Zaženi. Posledično se na zaslonu odpre okno »Izvajanje programa«. V polje Odpri v oknu Zaženi program vnesite pot do datoteke programa, ki ga želite zagnati.

Aplikacijo lahko zapustite s klikom na gumb “Zapri” ali z menijsko točko programa “Datoteka/Izhod” ali pa uporabite kombinacijo tipk Alt+F4.

4 . Celoten seznam modulov in komponent

Glavni obrazec vsebuje seznam vseh modulov, ki se uporabljajo v programu, in več izvedljivih stavkov, ki zagotavljajo ustvarjanje potrebnih oken in povezavo programa z operacijskim sistemom Windows. Vse glavno delo programa nadzira koda, ki jo vsebujejo moduli.

Ta programski izdelek vključuje naslednje module:

Unit1.pas je glavni modul programa, kjer se neposredno polnijo podatki o naročilih;

Unit2.pas - pošiljanje naročila trgovcu (terminal trgovca);

Unit3.pas - programski modul, kjer se polnijo podatki o merah izdelka (okna);

Unit4.pas - programski modul, kjer se izpolnijo podatki o namestitvi produkta (okno);

Unit5.pas - iskanje, filtriranje, razvrščanje po naročilih;

Enota6.pas - modul “O programu”.

Glavni obrazec vsebuje komponente, prikazane na sliki B.3. Slika prikazuje tudi »drevo« vseh komponent obrazca (slika B.4).

Slika B.3 – Glavne komponente obrazca

Glavne komponente obrazca:

TADOConnection - uporablja se za določanje baze podatkov in delo s transakcijami;

TADOTable - tabela dostopna preko ADO;

DataSource zagotavlja mehanizem za povezovanje komponent za dostop do podatkov (Tabela) z vizualnimi komponentami, ki prikazujejo podatke (DBGrid, DBEdit, DBListBox itd.)

TADOQuery - izvede poizvedbo (izbor) v bazo podatkov;

TMainMenu - ustvari glavni meni programa;

TDBGrid - prikazuje podatke iz baze v obliki tabele;

TEdit - polje za vnos besedilnih sporočil;

TButton - gumb;

TComboBox - spustni seznam;

TDBCtrlGrid - uporablja se za prikaz tabele v obliki "opeke";

TLabel - nalepke;

TGroupBox - plošča kot ločen element z drugimi komponentami;

TDBNavigator - komponenta za upravljanje navigacije in urejanje podatkov;

TDBEdit - polje za urejanje zapisa baze podatkov;

TDateTimePicker - izbirnik datuma;

TSpeedButton - hitri gumb;

TBitBtn - gumb, ki prenese dejanje na obrazec;

TBevel – zasnovano v aplikaciji za preprosto obris nečesa z okvirjem.

Glavne komponente obrazca so potrebne za prikaz tabel iz baze podatkov, za spreminjanje, dodajanje, brisanje, filtriranje, iskanje, premikanje v druge obrazce in za druga dejanja.

Slika B.4 – Struktura komponent

5 . Sporočilo uporabniku

Če je uporabnik vnesel napačne vrednosti za filtriranje podatkov baze podatkov, se prikaže sporočilo, prikazano na sliki B.5.

Slika B.5 - Sporočilo o napaki

Če je pri brisanju podatkov prišlo do napake, se prikaže sporočilo o napaki, prikazano na sliki B.6.

programska oprema plastično okno

Slika B.6 - Sporočilo o napaki.

Uporabnik je pri shranjevanju naročila pozabil vnesti številko računa, nato pa se izpiše sporočilo o napaki prikazano na sliki B.7.

Slika B.7 - Sporočilo o napaki

Ko poskusite izbrisati, se prikaže sporočilo, prikazano na sliki B.8.

Slika B.8 - Dialog z uporabnikom

Če je uporabnik ob shranjevanju naročila že vnesel številko obstoječega računa, se izpiše sporočilo na sliki B.9.

Slika B.9 - Dialog z uporabnikom

Objavljeno na Allbest.ru

...

Podobni dokumenti

Ustvarjanje razredov, ki izvajajo delo s seznami in njihovo uporabo pri problemu konstruiranja grafičnih modelov. Uporaba jezika C++ za implementacijo strukture seznama. Namen in pogoji uporabe programa. Vodnik za programerja in operaterja.

tečajna naloga, dodana 19.03.2010


Uporaba osnovnih lastnosti objektno usmerjenega programskega jezika C++ pri pisanju programa za implementacijo seznama nogometašev različnih vlog. Uporabniški priročnik in Programerski priročnik. Delo s seznamom, programski vmesnik.

tečajna naloga, dodana 20.07.2014


Opis vhodnih in izhodnih informacij. Zahteve za nabor tehničnih sredstev in za končni uporabniški vmesnik. Razvoj obrazcev za prikaz vhodnih in izhodnih podatkov. Oblikovanje programskih modulov. Uporabniški in programerski priročnik.

tečajna naloga, dodana 27.06.2015


Lastnosti algoritmov, merila kakovosti. Izdelava in uporaba programskega izdelka v jeziku Delphi. Vrsta operacijskega sistema. Notranja struktura programskega izdelka. Uporabniški in programerski priročnik, izračun stroškov in cene programa.

diplomsko delo, dodano 12.6.2009


Delphi kot programski izdelek s fenomenalnimi lastnostmi. Prevajalnik v strojno kodo. Objektno orientirani model komponent programske opreme. Razširljiva orodja za gradnjo baz podatkov. Programska koda.

test, dodan 30.07.2007


Razvoj strukturnega diagrama in vmesnika za programski paket za upravljanje spletnega mesta. Izbira programskega jezika. Načela testiranja programa. Razvoj priročnikov za operaterje in sistemske programerje. Izračun ocene stroškov za programski izdelek.

diplomsko delo, dodano 11.6.2012


Namen in področje uporabe industrijskih robotov. Razvoj programa "Kinematično gibanje" v okolju Delphi za določanje glavnih parametrov kinematskega gibanja. Opis delovnega mesta in seznam programov. Navodila za programerja in uporabnika.

predmetno delo, dodano 17.11.2014


Tehnična naloga. Načrti dela: začetni, fazni. Tehnični projekt. Programske tabele baze podatkov. Shema izmenjave podatkov. Testiranje programskih izdelkov. Operativna dokumentacija. Programerski vodnik. Navodila.

tečajna naloga, dodana 12/07/2007


Izdelava programskega izdelka na temo »Namen in glavne lastnosti palete komponent »Standard««, testiranje znanja študentov v okolju programskega jezika Delphi. Značilnosti metodike spremljanja znanja in sestava testnih nalog.

tečajna naloga, dodana 17.04.2011


Razvoj programa v Visual Basicu. Specifikacija za programski modul. Vnos, spreminjanje in brisanje podatkov po določenih zahtevah. Priročnik za sistemskega programerja, programerja in operaterja. Vzdrževanje baze podatkov v obliki Excel tabele.

Programerski priročnik se nanaša na operativno in tehnično dokumentacijo. Tak dokument se razvija za programske izdelke. Namenjen za seznanitev programerja, ki bo reševal določene probleme v zvezi z delovanjem tega programa.

Kdaj je potrebno vodenje programerja?

Programerjeva navodila so potrebna v več primerih:

Program, za katerega se sestavlja dokumentacija, je razvojno okolje ali knjižnica.
Ta programski izdelek zagotavlja platformo za pisanje standardnih programov ali sistemov.
Izdelek se distribuira skupaj s programsko kodo ali pa ga razvijalec nenehno spreminja.

S pomočjo takega dokumenta mora biti programer opremljen z vsemi potrebnimi informacijami, ki jih lahko uporabi za ustvarjanje lastnih programskih izdelkov na osnovi tega sistema. Informacije morajo biti zagotovljene v zadostni količini. Razvijalci imajo s pomočjo programerskega priročnika možnost beležiti trenutno stanje izdanega izdelka, da se izognejo zmedi pri izdajanju novih izdelkov.

Tipične naloge takega dokumenta vključujejo:

Pojasnitev in razlaga strokovnjaku trenutnega stanja predmetov, njihove lokacije in načinov interakcije. Prav tako mora vodstvo programerja jasno razlikovati med objekti, ki so prvotno vključeni v sistem, in objekti, ki jih programer ustvari samostojno.
Seznam dodatnih razvojnih orodij, ki bodo potrebna pri delu poleg trenutnega izdelka.
Pojasnitev sistemskih zahtev, programskega okolja in orodij, potrebnih za zagon.

GOST 19.504-79

Skupina T55

MEDDRŽAVNI STANDARD

Enotni sistem programske dokumentacije

PROGRAMSKI VODNIK

Zahteve glede vsebine in oblikovanja

Enotni sistem programske dokumentacije. Programerski priročnik Zahteve glede vsebine in oblike predstavitve

MKS 35.080

Datum uvedbe 1980-01-01

Z Odlokom Državnega odbora ZSSR za standarde z dne 12. januarja 1979 N 74 je bil datum izvajanja določen na 01.01.80.

IZDANJA (januar 2010) s spremembo št. 1, odobreno septembra 1981 (IUS 11-81).


Ta standard določa zahteve za vsebino in oblikovanje programskega dokumenta "Programer's Guide", opredeljeno GOST 19.101-77.

Standard je v celoti skladen s ST SEV 2095-80*.
________________
* Dostop do v besedilu omenjenih mednarodnih in tujih dokumentov je mogoč na kontaktu Pomoč strankam. - Opomba proizvajalca baze podatkov.

(Spremenjena izdaja, sprememba št. 1).

1. SPLOŠNE DOLOČBE

1. SPLOŠNE DOLOČBE

1.1. Struktura in oblika dokumenta sta določena v skladu z GOST 19.105-78.

Izdelava informativnega dela (opombe in vsebina) je obvezna.

1.2. Programerski priročnik mora vsebovati naslednje razdelke:

namen in pogoji uporabe programa;

značilnosti programa;

dostop do programa;

vhodni in izhodni podatki;

sporočila.

Glede na specifiko dokumenta je mogoče posamezne razdelke združiti ali uvesti nove.

2.1. V razdelku »Namen in pogoji uporabe programa« je treba navesti namen in funkcije, ki jih izvaja program, pogoje, potrebne za izvajanje programa (količina RAM-a, zahteve glede sestave in parametrov perifernih naprav, zahteve programske opreme itd.). ).

2.2. Poglavje "Značilnosti programa" mora vsebovati opis glavnih značilnosti in značilnosti programa (časovne značilnosti, način delovanja, sredstva za spremljanje pravilnega izvajanja in samozdravljenja programa itd.).

2.3. Poglavje »Pritožba na program« mora vsebovati opis postopkov za priklic programa (metode prenosa krmilnih in podatkovnih parametrov itd.).

2.4. V razdelku "Vhodni in izhodni podatki" je treba opisati organizacijo uporabljenih vhodnih in izhodnih informacij in po potrebi njihovo kodiranje.

2.5. V razdelku »Sporočila« morajo biti navedena besedila sporočil, izdanih programerju ali operaterju med izvajanjem programa, opis njihove vsebine in dejanja, ki jih je treba izvesti kot odgovor na ta sporočila.

2.6. Dodatek k priročniku za programerje lahko vsebuje dodatna gradiva (primere, ilustracije, tabele, grafe itd.).

Besedilo elektronskega dokumenta
pripravil Kodeks JSC in preveril glede na:
uradna objava
Enotni sistem programske dokumentacije:
Zbirka nacionalnih standardov. -
M.: Standardinform, 2010