Pravila za izradu programske dokumentacije. Registracija programske dokumentacije u skladu s espd, espd Registracija programske dokumentacije u skladu s GOST-om

programe za tehnička sredstva i druge programe, Opće karakteristike ulazne i izlazne informacije te zahtjevi i uvjeti organizacijske, tehničke i tehnološke prirode i sl.).

Na primjer: Program je pokrenut osobno računalo(PC) tipa IBM PC/AT. Za rad u interaktivnom načinu rada koriste se zaslon, tipkovnica i miš. Za podršku grafičkog načina rada potreban je EGA (VGA) adapter. Ulazni podaci pohranjuju se na diskete i/ili tvrde diskove. Program radi pod OS-om...

Dodatak opisu može sadržavati referentne materijale (ilustracije, tablice, grafikone, primjere itd.)

I ne zaboravite navesti naziv modula za pokretanje, kao i opis cijele procedure za pozivanje i učitavanje sustava

Na primjer: Program se preuzima upisivanjem naredbeni redak DOS naziv modula za pokretanje je SBM80N.EXE s mogućom indikacijom naziva podatkovne datoteke.

TEKST PROGRAMA (GOST 19.401-78)

Zahtjevi za dizajn programskog teksta prilično su jednostavni i prirodni za kompetentnog programera. Glavna stvar kojom se treba voditi prilikom izrade ovog dokumenta je da tekst programa treba biti čitljiv.

I dalje je obvezno sastavljanje informativnog dijela - napomena i sadržaja.

Glavninu dokumenta trebaju činiti tekstovi jednog ili više odjeljaka koji se nazivaju.

Tekst svake programske datoteke počinje "zaglavljem", koje označava:

· naziv programa,

· datum izrade programa,

· broj verzije,

· datum zadnje izmjene.

Komentari su obavezni, kao i strogo pridržavanje pravila uvlačenja. Zapamtite, čak i nemogućnost izrade softverske dokumentacije može biti opravdana. Ali ružan programski tekst – nikad. Pozivanje na činjenicu da je ovaj tekst razumljiv samom autoru ne uzima se za ozbiljno. Ne treba se sramiti dati programske tekstove drugima na čitanje.

PROGRAM I METODOLOGIJA ISPITIVANJA (GOST 19.301-79)

Ovaj dokument sadrži opis što i kako treba učiniti kako bi se uvjerio (i uvjerio kupca) da program radi ispravno. Zapravo, ovaj dokument je odlučujući za prihvaćanje

testovi. Dobro osmišljen ispitni program i metodologija ključ su za potpisivanje potvrde o prihvaćanju, tj. stvar za koju ste potrošili toliko truda i vremena.

Formalno, ovaj GOST se koristi za izradu planskih dokumenata i provođenje testnih radova za procjenu spremnosti i kvalitete softverskog sustava. Dokument sadrži opis predmeta i svrhe ispitivanja, zahtjeve za program i programska dokumentacija, testne alate i procedure, kao i opise testnih slučajeva.

Komponente ovog dokumenta lakše su i jasnije opisane u obliku primjera.

Ispitni objekt

Primjer: Ispitni objekt je program ..., namijenjen za

Svrha testiranja

Primjer: Provjera pouzdanosti programa.

Programski zahtjevi

Primjer: Rad programa ne smije dovesti do kvara (fatalnog poremećaja sustava). Organizacija dijaloga treba osigurati zaštitu od unosa netočnih podataka. Program bi trebao omogućiti dijagnostiku stanja sustava i poruke o greškama koje su se dogodile... itd.

Zahtjevi za softversku dokumentaciju

Primjer: Sadržaj softverske dokumentacije prezentirane tijekom testiranja:

· opis programa (GOST 19.402-78);

· program i metodologija ispitivanja (GOST 19.301-79);

· tekst programa (GOST 19.401-78).

Sredstva i postupak ispitivanja

Primjer: Program radi u skladu s radnim uvjetima operativnog sustava MS DOS (verzija ne niža od 3.0) na računalu kao što je IBM PC/AT, kao i na kompatibilnim. Za rad je također potreban adapter.

Postupak ispitivanja:

1. Program je pokrenut....

2. Odaberite...

3. Pritisnite...

4. Redom odabrano...

Test slučajevi

Primjer: Za testiranje su predloženi ... čiji su opisi sadržani u datotekama ... Sadržaj testnih datoteka i rezultati programa dani su u Dodatku 1.

I na kraju, razmotrimo posljednji ESPD standard koji nas zanima, a koji se zove

ZAHTJEVI ZA ISPISANE SOFTVERSKE DOKUMENTE (GOST 19.106-78)

Norma utvrđuje pravila za izvođenje programskih dokumenata za računala, komplekse i sustave, bez obzira na njihovu namjenu i opseg i namjenu. ESPD standardi.

Opći zahtjevi. Potrebno je crnom tintom unijeti pojedine riječi, formule, simbole (ručno crtačkim fontom), slova latinične i grčke abecede, kao i crtati dijagrame i crteže u programske dokumente izrađene strojno, strojno i rukopisno. ili tinta.

Tipfeleri i grafičke netočnosti otkrivene tijekom postupka izvođenja mogu se ispraviti brisanjem loše izvedenog dijela teksta (crteža) i nanošenjem ispravljenog teksta (grafike) na isti list strojopisom ili crnom tintom, ovisno o načinu izvođenja. dokument.

Oštećenje listova dokumenta, mrlje i tragovi nepotpuno izbrisanog teksta (grafike) nisu dopušteni.

Programski dokumenti izrađuju se na listovima formata A4. Osim

· Prihvatljivo je tiskati na A3 listove;

· Kod strojne izrade dokumenta dopuštena su odstupanja u veličini listova koji odgovaraju formatima A4 i A3, ovisno o mogućnostima korištenog tehnička sredstva; na listovima formata A4 i A3, predviđenim izlaznim karakteristikama uređaja za izlaz podataka, kod strojne izrade dokumenta;

· Kod izrade dokumenta tipografskom metodom moguće je koristiti listove tipografskih formata.

Materijali programskog dokumenta raspoređeni su sljedećim redoslijedom:

· naslovni dio:

- list odobrenja (ne ulazi u ukupan broj listova dokumenta);

- naslovna stranica (prva stranica dokumenta);

· informativni dio:

Anotacija;

- sadržaj;

· glavni dio:

- tekst dokumenta (sa slikama, tablicama i sl.);

- popis pojmova i njihovih definicija;

- popis kratica;

aplikacije;

- predmetni indeks;

- popis referentnih dokumenata;

· dio zapisivanja promjena:

- promijeniti upisni list.

Konstrukcija dokumenta. Ako je potrebno, dopušteno je podijeliti dokument na dijelove. Podjela na dijelove provodi se na razini koja nije niža od odjeljka. Svaki dio popunjava se zasebno, a na kraju sadržaja prvog dijela treba navesti nazive preostalih dijelova.

U dokument je dopušteno uključiti dijelove programskog teksta, oblikovane u skladu s pravilima jezika na kojem je programski tekst napisan.

Sažetak je objavljen na zasebna stranica(stranice), s naslovom "SAŽETAK", numerirani i uključeni u sadržaj dokumenta.

Tekst svakog dokumenta, po potrebi, dijeli se na odlomke, a odlomci u podstavke, neovisno o tome je li dokument podijeljen na dijelove, odjeljke i pododjeljke ili ne.

Naslovi odjeljaka pišu se velikim slovima i postavljaju simetrično u odnosu na desni i lijevi rub teksta. Naslovi pododjeljaka pišu se iz odlomka mala slova(osim prvog kapitala). Rastavljanje riječi u naslovima nije dopušteno. Na kraju naslova nema točke. Preporuča se započeti svaki odjeljak na novom listu.

Odjeljke, pododjeljke, paragrafe i podstavke treba numerirati arapskim brojevima s točkom. Odjeljci moraju imati redni broj (1, 2 itd.)

Tekst dokumenta. Tekst dokumenta treba biti kratak, jasan, isključujući mogućnost pogrešnog tumačenja. Pojmovi i definicije moraju biti jedinstveni i u skladu s utvrđenim standardima, a u nedostatku - općeprihvaćeni u znanstvenoj i stručnoj literaturi, te biti navedeni u popisu pojmova.

Potrebna objašnjenja teksta dokumenta mogu se dati u fusnotama. Bilješka je označena brojem sa zagradom postavljenom na razini gornjeg ruba fonta.

Ako se bilješka odnosi na jednu riječ, znak fusnote stavlja se neposredno uz tu riječ, a ako se odnosi na rečenicu u cjelini, onda na kraju rečenice. Tekst fusnote stavlja se na kraj stranice i od glavnog teksta odvaja crtom duljine 3 cm na lijevoj strani stranice.

Ilustracije. Ilustracije se mogu nalaziti u tekstu dokumenta i (ili) u prilozima. Ilustracije, ako su dostupne ovaj dokument više od jednog, numerirani su arapskim brojevima u cijelom dokumentu.

U dodacima, ilustracije su numerirane unutar svakog dodatka redoslijedom utvrđenim za glavni tekst dokumenta. Linkovi na ilustracije dani su tipom: "Sl. 12" ili "(Sl. 12)". Ilustracije mogu imati tematski naslov i tekst opisa koji objašnjava sadržaj ilustracije.

Formule. Formule u dokumentu, ako ih ima više, numeriraju se arapskim brojevima, uz broj se stavlja desna strana stranice, u zagradama na razini formule. Unutar cijelog dokumenta ili njegovih dijelova, ako je dokument podijeljen na dijelove, formule imaju kontinuirani broj.

Upućivanje u tekstu na redni broj formule navodi se u zagradama, na primjer: "u formuli (3)". Kod dijeljenja dokumenta na dijelove, broj dijela se stavlja ispred rednog broja formule i odvaja se od zadnje točke, na primjer: "u formuli (1.4)".

Značenje simbola uključenih u formulu mora biti navedeno neposredno ispod formule. Značenje svakog znaka ispisuje se u novom retku redoslijedom kojim su navedeni u formuli. Prvi redak prijepisa mora započeti riječju "gdje", bez dvotočke iza nje.

Linkovi. Upućivanja na standarde i druge dokumente dopuštena su u dokumentima o politici. Treba se pozvati na dokument u cjelini ili na njegove dijelove (uz naznaku i naziv dokumenta, broj i naziv odjeljka ili priloga).

Dopušteno je navesti samo oznaku dokumenta i (ili) odjeljaka bez navođenja njihovih naziva. Upućivanje na pojedine pododjeljke, odlomke i ilustracije drugog dokumenta nije dopušteno. Dopuštene su poveznice unutar dokumenta na odlomke, ilustracije i pojedinačne pododjeljke.

Bilješke Bilješke uz tekst i tablice navode samo referentne podatke i podatke s objašnjenjima. Jedna bilješka nije numerirana. Zatim iza riječi "Napomena" stavljaju točku. Nekoliko bilješki treba redom numerirati arapskim brojevima s točkom. I u ovom slučaju, dvotočka se stavlja iza riječi "Napomena". Tekst bilješki može se ispisati samo u jednom intervalu.

Kratice. Nisu dopuštene kratice riječi u tekstu i natpisi ispod ilustracija, osim:

· kratice utvrđene u GOST-u 2.316-68, i općenito prihvaćen na ruskom jeziku;

· kratice koje se koriste za označavanje programa i njihovih dijelova

I načini rada, u jezicima upravljanja zadacima, u alatima za postavke programa itd., označeni latiničnim slovima

abeceda.

Prijave. Ilustrirani materijal, tablice ili popratni tekst mogu se prikazati u obliku priloga. Prilozi se sastavljaju kao nastavak ovog dokumenta na sljedećim stranicama ili se izdaju kao poseban dokument.

Svaka aplikacija mora započeti s nova stranica s indikacijom na desnoj strani gornji kut riječi "Aplikacija" i imaju tematski naslov. Ako u dokumentu postoji više od jednog privitka, svi prilozi su numerirani arapskim brojevima (bez znaka 'Ne'), na primjer:

Dodatak 1, Dodatak 2 itd.

Prilikom izdavanja zahtjeva kao posebne isprave, na naslovnoj stranici ispod naziva isprave treba naznačiti riječ "Prilog", a ako je više prijava, treba navesti i njen redni broj.

Dokumentacija korisničkog priručnika specifikacija softverskog proizvoda

Korisnička dokumentacija odnosi se na dokumentaciju koja krajnjem korisniku pruža informacije o instalaciji i radu programskog paketa. Informacije o pakiranju odnose se na informacije prikazane na vanjskom pakiranju softverskog paketa. Njegova je svrha pružiti potencijalnim kupcima početne informacije o programskom paketu.

Korisnička dokumentacija softvera objašnjava korisnicima kako moraju nastaviti s prijavom ovaj program. Neophodno je ako program uključuje bilo kakvu interakciju s korisnicima. Takva dokumentacija uključuje dokumente koji vode korisnika kada instalira program s odgovarajućim postavkama za okolinu aplikacije, kada koristi program za rješavanje svojih problema i kada upravlja programom (na primjer, kada ovaj softver komunicira s

S drugi sustavi). Ovi dokumenti djelomično se bave problemima održavanja softvera, ali ne rješavaju probleme povezane s

S modifikacija programa.

U S tim u vezi treba razlikovati dvije kategorije korisnika: obične korisnike programa i administratore. Običan korisnik programa(krajnji korisnik) koristi program za rješavanje svojih problema (u svom predmetnom području). Ovo bi mogao biti inženjer koji dizajnira tehnički uređaj, ili blagajnik koji prodaje karte za vlak koristeći ovaj program. Možda ne zna mnoge pojedinosti rada računala ili načela programiranja. Administrator programa (administrator sustava) upravlja korištenjem programa od strane običnih korisnika i osigurava održavanje softvera koje nije vezano uz modificiranje programa. Na primjer, može regulirati prava pristupa programu između običnih korisnika, komunicirati s dobavljačima programa ili izvoditi određene radnje kako bi program nastavio raditi ako je uključen kao dio drugog sustava.

Sastav korisničke dokumentacije ovisi o publici korisnika kojoj je namijenjena i o načinu korištenja dokumenata. Publika se ovdje odnosi na kontingent korisnika

za koje postoji potreba za određenom korisničkom dokumentacijom. Uspješan korisnički dokument uvelike ovisi o točnom identificiranju publike kojoj je namijenjen. Korisnička dokumentacija treba sadržavati podatke potrebne svakoj publici. Način korištenja dokumenta odnosi se na metodu koja određuje kako se taj dokument koristi. Obično korisnik treba velike programski sustavi dokumenti su potrebni za proučavanje softvera (koristite kao upute) ili za pojašnjenje nekih informacija (koristite kao referentnu knjigu).

Opći funkcionalni opis softvera. daje Kratak opis funkcionalnost softverski alat. Namijenjeno korisnicima koji moraju odlučiti koliko im je određeni softverski alat potreban.

Vodič za instalaciju softvera. Dizajnirano za administratori sustava. Mora detaljno propisati kako instalirati sustave u određenom okruženju. Mora sadržavati opis strojno čitljivog medija na kojem se softver isporučuje, datoteke koje predstavljaju softver i minimalne zahtjeve za konfiguraciju hardvera.

Upute za korištenje softvera. Dizajniran za obične korisnike. Sadrži potrebne informacije o korištenju softvera, organizirane u obliku pogodnom za proučavanje.

Priručnik o korištenju softvera. Dizajniran za obične korisnike. Sadrži potrebne podatke o korištenju softvera, organizirane u obliku pogodnom za selektivno pretraživanje pojedinih dijelova.

Vodič za upravljanje softverom. Namijenjeno administratorima sustava. Treba opisati poruke koje se generiraju kada softver komunicira s drugim sustavima i kako odgovoriti na te poruke. Nadalje, ako softverski alat koristi hardver sustava, ovaj dokument može objasniti kako održavati taj hardver.

Izrada korisničke dokumentacije započinje odmah nakon izrade vanjskog opisa. Kvaliteta ove dokumentacije može značajno odrediti uspjeh programa. Trebao bi biti vrlo jednostavan i lak za korištenje (inače ovaj softver uopće ne bi bio vrijedan izrade). Stoga, iako nacrte korisničkih dokumenata stvaraju glavni programeri softvera, za izradu konačnih verzija često se koriste profesionalni tehnički pisci.

Osim toga, radi osiguranja kvalitete korisničke dokumentacije, razvijen je niz standarda koji propisuju postupak izrade te dokumentacije, formuliraju zahtjeve za svaku vrstu korisničkih dokumenata te određuju njihovu strukturu i sadržaj.

1.4 Programerski vodič

Dokumentacija sustava opisuje softver sa stajališta njegovog razvoja.

Ova dokumentacija je neophodna ako softver uključuje proučavanje kako je strukturiran (dizajniran) i nadogradnju svojih programa. Kao što je navedeno, održavanje je stalan razvoj. Stoga, ako je potrebno modernizirati programski alat, u taj se posao uključuje poseban tim razvojnih i održavatelja. Ovaj tim će se morati baviti istom dokumentacijom koja je definirala aktivnosti tima inicijalnih (glavnih) programera softvera - s jedinom razlikom što će ta dokumentacija za razvojni tim, u pravilu, biti strana (kreirana je od strane drugog tima). Tim za razvoj održavanja morat će proučiti ovu dokumentaciju kako bi razumio strukturu i razvojni proces softvera koji se nadograđuje te napraviti potrebne izmjene u ovoj dokumentaciji, ponavljajući u velikoj mjeri tehnološki procesi, uz pomoć kojeg je stvoren originalni softver.

Dokumentacija softverske podrške može se podijeliti u dvije skupine:

1. dokumentacija koja definira strukturu softverskih programa i strukture podataka te tehnologiju za njihov razvoj;

2. dokumentaciju koja će vam pomoći da napravite promjene u softveru.

Dokumentacija prve skupine sadrži završne dokumente svake tehnološke faze razvoja softvera. Sadrži sljedeće dokumente.

Vanjski opis softvera (Dokument sa zahtjevima). Opis arhitekture softvera

arhitektura), uključujući vanjsku specifikaciju svakog od njegovih programa.

Za svaki softverski program, opis njegove modularne strukture, uključujući vanjsku specifikaciju svakog modula uključenog u njega.

Za svaki modul - njegova specifikacija i opis strukture

(opis dizajna).

Tekstovi modula u odabranom programskom jeziku (ispisi izvornog koda programa).

Dokumenti o potvrdi valjanosti koji opisuju kako je utvrđena valjanost

svaki softverski program i kako su informacije o jamstvu povezane sa softverskim zahtjevima.

Dokumenti za provjeru valjanosti prvenstveno uključuju dokumentaciju o testiranju (dizajn testa i opis skupa testova), ali mogu uključivati ​​i rezultate drugih vrsta testiranja softvera, na primjer, dokaz o svojstvima programa.

Dokumentacija druge skupine sadrži

Vodič za održavanje sustava, koji opisuje poznate probleme sa softverom, opisuje koji dijelovi sustava ovise o hardveru i softveru i kako se razvoj softvera uzima u obzir pri njegovom dizajnu.

Čest problem u održavanju softvera je osigurati da svi njegovi prikazi budu u toku (ostanu dosljedni) kada se softver promijeni. Kako bi se to pomoglo, odnosi i ovisnosti između dokumenata i njihovih dijelova moraju biti snimljeni u bazi podataka za upravljanje konfiguracijom.

Zaključak Brzo povećanje složenosti i veličine modernih sustava

programa, uz istodobno povećanje odgovornosti funkcija koje se obavljaju, naglo je povećao zahtjeve kupaca i korisnika za njihovu kvalitetu i sigurnost korištenja. Dokazano sredstvo za osiguranje visoke učinkovitosti i kvalitete funkcioniranja programa i programski sustavi dokumentacijski su standardi razvijeni uz sudjelovanje predstavnika vodećih tvrtki u industriji.

U Rusiji u području pružanja životni ciklus i kvalitete složenih programskih paketa uglavnom se koristi skupina zastarjelih GOST standarda koji za svjetskom razinom zaostaju 5-10 godina.

Tijekom proteklih nekoliko godina stvoreni su mnogi ISO standardi za reguliranje životnog ciklusa procesa i proizvoda. softver te baze podataka koje mogu poslužiti kao osnova za sustave osiguranja kvalitete softverski proizvodi. Za poboljšanje kvalitete proizvoda potrebno je poznavati i pravilno koristiti sve standarde programske dokumentacije.

G O S U D A R S T V E N Y S T A N D A R T S O Y W A S S R

Sustav tehničke dokumentacije za automatizirane sustave upravljanja

GOST 24.207-80

ZAHTJEVI ZA SADRŽAJ SOFTVERSKIH DOKUMENATA
Sustav tehničke dokumentacije računalnih sustava upravljanja. Zahtjevi za sadržaj dokumenata na softveru

Dekretom Državnog odbora za standarde SSSR-a od 14. svibnja 1980. br. 2101 utvrđen je datum uvođenja

od 01.01.1981

Ovaj se standard primjenjuje na tehnička dokumentacija za automatizirane upravljačke sustave (ACS) svih vrsta, razvijen za sve razine upravljanja (osim za nacionalne), i utvrđuje zahtjeve za sadržaj dokumenata uključenih u skladu s GOST 24.101-80 kao dio softverske dokumentacije u ACS projektima.

1. OPĆE ODREDBE

1.1. Softverska dokumentacija je namijenjena za:

  • opisati dizajnerska rješenja za softver u dokumentu “Opis softvera ACS”.
  • utvrditi zahtjeve za program (skup programa) u dokumentu “ Tehnički zadatak»;
  • opisati rješenja koja osiguravaju održavanje, proizvodnju i rad programa (skupa programa) u dokumentima „Objašnjenje“, „Opis aplikacije“, „Opis programa“, „Specifikacija“, „Programerski vodič“, „Upute za operatera“. Vodič”, “Tekst programa” , “Obrazac”, “Postupak i metode ispitivanja”;
  • provjeriti funkcionalnost programa (skupa programa) u dokumentu “Opis testnog slučaja”.

1.2. Prilikom izrade dokumenata za dijelove automatiziranog upravljačkog sustava, sadržaj odjeljaka svakog dokumenta ograničen je okvirom odgovarajućeg dijela.

1.3. Ovisno o namjeni i specifičnim značajkama stvorenih automatiziranih sustava upravljanja, dopušteno je uključiti dodatne odjeljke u dokumente, čiji sadržajni zahtjevi nisu utvrđeni ovom normom. Nedostatak projektnih rješenja za dio dokumenta evidentira se u odgovarajućem odjeljku s potrebnim objašnjenjima.

1.4. Zahtjevi za sadržaj dokumenata "Tehničke specifikacije", "Objašnjenje", "Opis primjene", "Specifikacija", "Priručnik za rukovanje", "Tekst programa", "Obrazac", "Postupak ispitivanja i metodologija" utvrđuje GOST 19.201-78, GOST 19.404-79, GOST 19.502-78, GOST 19.202-78, GOST 19.505-79, GOST 19.401-78, GOST 19.501-78 i GOST 19.301-79.

(Promijenjeno izdanje, dopuna br. 1).

2. ZAHTJEVI ZA SADRŽAJ DOKUMENATA

2.1. Opis ACS softvera

2.1.1. Dokument mora sadržavati uvodni dio i odjeljke:

  • struktura softvera;
  • glavne funkcije programskih dijelova;
  • metode i alati za razvoj softvera;
  • operacijski sustav;
  • alati za osnaživanje operacijski sustav.

2.1.2. Uvodni dio treba sadržavati osnovne informacije o tehničkoj, informacijskoj i drugim vrstama potpore sustava automatiziranog upravljanja potrebne za razvoj softvera ili poveznicu na relevantne dokumente projekta sustava automatiziranog upravljanja.

2.1.3. Odjeljak "Struktura softvera" trebao bi sadržavati popis dijelova softvera, navodeći njihove odnose i obrazloženje za identificiranje svakog od njih.

2.1.4. Odjeljak “Glavne funkcije programskih dijelova” treba sadržavati pododjeljke u kojima se za svaki dio softvera navodi svrha i opis glavnih funkcija.

(Promijenjeno izdanje, dopuna br. 1).

2.1.5. Odjeljak „Metode i alati za razvoj softvera” treba sadržavati popis programskih metoda i alata za razvoj softvera sustava automatiziranog upravljanja, s naznakom dijelova softvera u čijem razvoju treba koristiti odgovarajuće metode i alate.

2.1.6. Odjeljak "Operativni sustav" treba sadržavati:

  • naziv, oznaka i kratki opis odabranog operativnog sustava i njegove verzije u okviru koje će se izvoditi razvijeni programi, uz obrazloženje izbora i navođenje izvora tamo gdje su navedeni Detaljan opis odabrana verzija;
  • naziv priručnika u skladu s kojim treba generirati odabranu verziju operativnog sustava;
  • zahtjevi za opciju generiranja odabrane verzije operativnog sustava.

2.1.7. Odjeljak "Alati koji proširuju mogućnosti operativnog sustava" treba sadržavati pododjeljke u kojima za svaki korišteni alat koji proširuje mogućnosti operativnog sustava trebate navesti:

  • naziv, oznaku i kratki opis proizvoda, s obrazloženjem potrebe njegove uporabe i naznakom izvora, koji daje detaljan opis odabranog proizvoda;
  • naziv priručnika u skladu s kojim bi proizvod koji se koristi trebao biti konfiguriran za određenu primjenu;
  • zahtjevi za postavljanje korištenog alata.

2.2. Opis programa

2.2.2. Za program (skup programa) dobiven korištenjem prethodno razvijenog softvera, dokument “Opis programa” treba dopuniti odjeljkom “Postavljanje softvera”.

2.2.3. Odjeljak "Konfiguracija softvera" treba sadržavati:

  • naziv, oznaka korištenog softvera, opis postupaka potrebnih za njihovo konfiguriranje ili poveznice na radnu dokumentaciju ovih alata;
  • popis elemenata korištene programske opreme potrebne za dobivanje programa (skupa programa);
  • opis postavki na jeziku navedenom u radnoj dokumentaciji za korišteni softver.

2.3. Programerski vodič

2.3.1. Dokument o sastavu odjeljaka i njihovom sadržaju mora biti u skladu s GOST 19.504-79 i, osim toga, sadržavati odjeljak "Informacije o obliku prezentacije programa (skupa programa)."

2.3.2. Rubrika "Podaci o obliku prikazivanja programa (seta programa)" mora sadržavati podatke o mediju na kojem je program snimljen, o sadržaju i sustavu kodiranja informacija snimljenih na mediju, kao i podatke potrebne za čitanje informacija iz medija.

2.3.3. Za program (skup programa) koji se može prilagoditi uvjetima određene aplikacije, dokument "Programerski vodič" uključuje odjeljke:

2.3.4. Dopušteno je za program (skup programa) koji se može prilagoditi uvjetima određene aplikacije, umjesto odjeljaka navedenih u klauzuli 2.3.3, razviti zasebni dokument „Vodič za programiranje sustava” koji ispunjava zahtjeve GOST-a 19.503-79.

2.4. Opis testnog slučaja

2.4.1. Dokument mora sadržavati odjeljke:

  • ugovoreni sastanak;
  • početni podaci;
  • rezultati izračuna;
  • provjera programa (skupa programa).

2.4.2. Odjeljak “Namjena” treba sadržavati popis parametara i kratak opis funkcije koju implementira program (skup programa) koji se testira testnim primjerom.

2.4.3. Rubrika „Početni podaci” mora sadržavati opis početnih podataka za testiranje programa (skupa programa) s prikazom početnih podataka. Dopušteno je prezentirati izvorne podatke u obliku ispisa iz ADCP-a.

2.4.4. Odjeljak "Rezultati izračuna" treba sadržavati rezultate obrade početnih podataka programom (skupom programa), omogućujući procjenu ispravnog izvršavanja funkcija koje se testiraju i vrijednosti parametara koji se testiraju. Dopušteno je rezultate izračuna prikazati u obliku ispisa iz ADCP-a.

2.4.5. Odjeljak "Provjera programa (skupa programa)" treba sadržavati:

  • opis sastava tehničkih sredstava potrebnih za rad programa (skupa programa), odnosno poveznica na odgovarajuće programske dokumente;
  • opis postupaka za generiranje početnih podataka za provjeru programa (skupa programa), pozivanje programa (skupa programa) koji se testira i dobivanje rezultata izračuna;
  • opis radnji operatera pri pripremi početnih podataka i testiranju programa (skupa programa) na testnom primjeru.
* Ponovno izdanje (svibanj 1986.) s promjenom br. 1, odobrenom u kolovozu 1985. (IUS 11-85).
Do vrha

GOST 19.105-78* (Opći zahtjevi za programske dokumente)

Iz ovog GOST-a dobivamoopći uvjeti za izradu programskih dokumenata.Ispod su najvažniji dijelovi.

  • Ova norma utvrđuje opće zahtjeve za izradu programskih dokumenata za računala, komplekse i sustave, bez obzira na njihovu namjenu i opseg i predviđene standardima Jedinstveni sustav programska dokumentacija (ESPD) za bilo koju metodu izvršavanja dokumenata na različitim medijima za pohranu.
  • Programski dokument sastoji se od sljedećih konvencionalnih dijelova:
    • titula;
    • informativni;
    • Osnovni, temeljni;
    • upis promjena.
  • Naslovni dio sastoji se od odobrenja i Naslovnica. Pravila za izradu lista odobrenja i naslovne stranice utvrđena su u skladu s GOST 19.104-78.
  • Informacijski dio treba se sastojati od sažetka i sadržaja.
    • Potreba uključivanja informacijskog dijela u različite vrste programskih dokumenata utvrđena je relevantnim ESPD standardima za te dokumente.
    • Napomena daje informacije o namjeni dokumenta i Sažetak njegov glavni dio.
    • Sadržaj uključuje popis zapisa o strukturnim elementima glavnog dijela dokumenta, od kojih svaki uključuje:
      • oznaka strukturnog elementa (broj odjeljka, pododjeljka itd.);
      • naziv strukturnog elementa;
      • adresu strukturnog elementa na mediju za pohranu (na primjer, broj stranice, broj datoteke itd.).
  • Sastav i struktura glavnog dijela programskog dokumenta utvrđeni su ESPD standardima za relevantne dokumente.
  • Promjena dijela za bilježenje(mora biti prisutan u svakom programskom dokumentu)
    • Svaka promjena u programskom dokumentu bilježi se u ovom dijelu u skladu sa zahtjevima GOST 19.603-78.
Do vrha
==================================
GOST 19.106-78* (Opći zahtjevi za programske dokumente izrađene u tiskanom obliku
put)
Iz ovog GOST-a dobivamo Opća pravila za način tiskanjaprogramske dokumente. Ispod su najvažniji dijelovi.
  • Ova norma utvrđuje pravila za izvođenje programskih dokumenata za računala, komplekse i sustave, bez obzira na njihovu namjenu i opseg primjene i predviđena standardima Jedinstvenog sustava programske dokumentacije (USPD) za tiskanu metodu izvođenja.
  • Norma se ne odnosi na programski dokument “Programski tekst”.
  • Sastav i struktura programskog dokumenta utvrđuje se u skladu s GOST 19.105-78.
  • Programski dokument je izvršens jedne strane lista, u dva razmaka; dopušteno u jednom ili jednom i pol intervalu.
  • Programske dokumente izrađuju:
    • na listovima formata A4 (GOST 2.301-68) - pri pripremi dokumenta tipkanjem ili rukopisom (obrazac 1). Dopušteno je crtanje na A3 listovima.


  • Materijali programskog dokumenta raspoređeni su sljedećim redoslijedom:
    • naslovni dio:
      • list odobrenja (ne ulazi u ukupan broj listova dokumenta);
      • naslovna stranica (prva stranica dokumenta);
    • informativni dio:
      • anotacija;
      • sadržaj;
    • glavni dio:
      • tekst dokumenta (sa slikama, tablicama i sl.);
      • aplikacije;
      • popis pojmova, popis kratica, popis slika, popis tablica, predmetno kazalo, popis referentnih dokumenata;
    • dio zapisivanja promjena:
      • promijeniti upisni list.
  • Sažetak se stavlja na posebnu (numeriranu) stranicu s naslovom „SAŽETAK” i nije numeriran kao odjeljak.
    • Anotacija označava izdanje programa i ukratko opisuje svrhu i sadržaj dokumenta. Ako se dokument sastoji od više dijelova, u napomeni se navodi ukupan broj dijelova.
  • Sadržaj dokumenta nalazi se na zasebnoj (numeriranoj) stranici (stranicama) iza napomene, s naslovom "SADRŽAJ", nije numeriran kao odjeljak i uključen je u ukupan broj stranica dokumenta.
  • Naslovi odjeljaka pišu se velikim slovima i postavljaju simetrično u odnosu na desni i lijevi rub teksta.
  • Naslovi pododjeljaka pišu se iz odlomka malim slovima (osim prvog velikog).
  • Rastavljanje riječi u naslovima nije dopušteno. Na kraju naslova nema točke.
  • Udaljenost između naslova i sljedećeg teksta, kao i između naslova odjeljaka i pododjeljaka, treba biti jednaka:
    • pri izvršavanju dokumenta tipkanjem - dva intervala.
  • Za odjeljke i pododjeljke, čiji je tekst napisan na istoj stranici s tekstom prethodnog odjeljka, razmak između posljednjeg reda teksta i sljedećeg naslova treba biti jednak:
    • pri izvršavanju dokumenta tipkanom metodom - tri tipkana intervala.
  • Odjeljke, pododjeljke, paragrafe i podstavke treba numerirati arapskim brojevima s točkom.
  • Unutar odjeljka moraju postojati kontinuirani brojevi za sve pododjeljke, paragrafe i podstavke uključene u ovaj odjeljak.
  • Numeracija pododjeljaka uključuje broj odjeljka i redni broj pododjeljka uključenog u ovaj odjeljak, odvojene točkom (2.1; 3.1 itd.).
  • Ako postoje odjeljci i pododjeljci, uz broj pododjeljka iza točke dodaje se redni broj točke i podtočke (3.1.1, 3.1.1.1 itd.).

Primjer strukture teksta programskog dokumenta i numeriranja njegovih odjeljaka, pododjeljaka, stavaka i podstavaka.

  • Tekst dokumenta treba biti kratak, jasan, isključujući mogućnost pogrešnog tumačenja.
  • Pojmovi i definicije moraju biti jedinstveni i u skladu s utvrđenim standardima, a u nedostatku - općeprihvaćeni u znanstvenoj i stručnoj literaturi, te biti navedeni u popisu pojmova.
  • Potrebna objašnjenja teksta dokumenta mogu se dati u fusnotama.
    • Bilješka je označena brojem sa zagradom postavljenom na razini gornje rubne linije fonta, na primjer: "ispisni uređaj 2) ..." ili "papir 5)".
    • Ako se bilješka odnosi na jednu riječ, znak fusnote stavlja se neposredno uz tu riječ, a ako se odnosi na rečenicu u cjelini, onda na kraju rečenice. Tekst fusnote stavlja se na kraj stranice i od glavnog teksta odvaja crtom duljine 3 cm na lijevoj strani stranice.
  • Ilustracije, ako ih u pojedinom dokumentu ima više, numeriraju se arapskim brojevima kroz cijeli dokument.
  • Formule u dokumentu, ako ih ima više, numeriraju se arapskim brojevima, a broj se stavlja na desnoj strani stranice, u zagradi na razini formule.
  • Značenje simbola i numeričkih koeficijenata uključenih u formulu mora biti navedeno neposredno ispod formule. Značenje svakog znaka ispisuje se u novom retku redoslijedom kojim su navedeni u formuli. Prvi redak prijepisa treba započeti riječju "gdje", bez dvotočke iza nje.
  • U programskim dokumentima dopušteno je pozivanje na standarde (osim na standarde poduzeća), tehničke specifikacije i druge dokumente (na primjer, dokumente državnih nadzornih tijela, pravila i propise Državnog odbora za izgradnju SSSR-a). Pri upućivanju na norme i tehničke specifikacije navedena je njihova oznaka.
  • Treba se pozvati na dokument u cjelini ili na njegove dijelove (uz naznaku i naziv dokumenta, broj i naziv odjeljka ili priloga). Kod ponavljanja referenci na odjeljak ili aplikaciju navodi se samo broj.
  • Bilješke uz tekst i tablice navode samo referentne podatke i podatke s objašnjenjima.
    • Jedna bilješka nije numerirana. Iza riječi "Napomena" stavite točku.
    • Nekoliko bilješki treba redom numerirati arapskim brojevima s točkom. Iza riječi “Napomena” staviti dvotačku.
  • Nisu dopuštene kratice riječi u tekstu i natpisi ispod ilustracija.
  • Ilustrirani materijal, tablice ili popratni tekst mogu se prikazati u obliku priloga.
  • Svaka prijava mora započeti na novoj stranici s naznakom "DODATAK" u gornjem desnom kutu i imati tematski naslov koji se ispisuje simetrično u odnosu na tekst velikim slovima.(na kraju, za izradu projekta trebamo samo registracijski list promjena).
    • Ovaj standard utvrđuje pravila za izmjene programskih dokumenata predviđenih standardima Jedinstvenog sustava programske dokumentacije (USPD) i tiskanih.
    Zbog značajne količine informacija u ovom GOST-u i radi uštede prostora na ovoj stranici, preporučujem da je pogledate sami GOST 19.604-78* . Primjer gotovog dizajna"promjena registracije"Možete ga pogledati u bilo kojem programskom dokumentu u odjeljku DOWNLOAD

    Do vrha
    ==================================

Pravila prijave i zahtjevi za sadržaj kolegija

2. izdanje

projekti (radovi) i završni kvalifikacijski radovi

stranica 39 od 73

Montažni crtež sklopne jedinice

pod brojem 8, uključen u proizvod 1

PK.760108.000 SB

Montažni crtež zasebnog sklopa

jedinice 4

PK.760004.000 SB

Crtež općeg pogleda zasebnog sklopa

jedinice 4

PK.760004.000 VO

Crtež dijela broj 16 uključen u

montažna jedinica 8 proizvoda 1

Crtež dijela broj 120 uključen

zasebna montažna jedinica 4

Dijagram električnog kruga proizvoda 1

PK.760100.000 E3

Shema kinematskog kruga, odvojena

nema montažne jedinice 4

PK.760400.000 K3

Specifikacija montažne jedinice 8 proizvoda 1

10 Izrada tehnološke dokumentacije

10.1 Tehnološka dokumentacija nastavnih projekata (radova) i završnih kvalifikacijskih radova izrađuje se u skladu sa zahtjevima ESTD normi.

10.2 Tehnološki dokumenti trebaju uključivati:

– naslovna stranica, dizajnirana u skladu s GOST-om 3.1105-84 “ESTD. Obrazac i pravila za pripremu dokumenata Opća namjena“ (Obrazac 2a).

– karta rute izdana u skladu s GOST-om 3.1118-82 “ESTD. Obrasci i pravila za izradu karata ruta“;

– obrada operativnih kartica i operativnih

proračunske i tehnološke karte za tehnološke operacije na CNC strojevima - u skladu s GOST 3.1404-86 “ESTD. Obrasci i pravila za izradu dokumenata za tehnološke procese i operacije rezanja";

– bravarske radne kartice, vodovodni i montažni radovi u skladu s GOST 3.1407-86 “ESTD. Obrasci i zahtjevi za popunjavanje i obradu dokumenata za tehnološke procese (operacije) specijalizirane za metode montaže";

– karte skica (ako je potrebno) prema GOST-u 3.1105-84 i GOST 3.1128-93 “ESTD. Opća pravila izrada grafičkih tehnoloških dokumenata“;

– kartice za kontrolu operativnog procesa prema GOST-u 3.1502-85 “ESTD. Obrasci i pravila za pripremu dokumenata za tehnički pregled";

– drugu tehnološku dokumentaciju (po potrebi ili prema odluci voditelja projekta).

10.3 Crteži za popravak izvode se u skladu s pravilima propisanim GOST 2.604-88 "Crteži za popravak".

10.4 Tehnološki dokumenti moraju biti uvezani

neposredno u obrazloženju nastavnog (projektnog) rada ili nakon prijava, specifikacija i popisa elemenata. Tehnološki dokumenti imaju svoju numeraciju.

11. Priprema programskih dokumenata

11.1 Dokumenti različitih problematičnih područja razvijeni u predmetnim projektima (radovima) i završnim kvalifikacijskim radovima moraju biti oblikovani na sljedeći način:

– programske dokumente – u skladu sa zahtjevima ESPD-a,

– dokumenti za automatizirani sustav upravljanje - prema državnim standardima sustava tehnološke dokumentacije za automatizirane sustave upravljanja. 11.2 Programski dokumenti (popisi programa) moraju sadržavati:

– tekst programa, dizajniran u skladu s GOST 19.401;

– opis programa, izrađen u skladu s GOST 19.402;

– opis bilješke dan u skladu s GOST 19.502;

– druge programske dokumente (po potrebi).

11.3 Popisi programa stavljaju se u aplikacije uz obavezne poveznice na njih u PP.

11.4 Programski kod može biti popraćen komentarima. Prilikom izrade oglasa preporuča se koristiti font Courier New, veličina – 12 pt, prored – jednostruki. Preporuča se odvojiti semantičke blokove praznim redcima, kao i vizualno označiti ugniježđene strukture pomoću uvlaka.

11.5 Ključne riječi i komentari u popisima programa mogu biti u kurzivu. U glavnom tekstu PP, nazivi biblioteka, potprograma, konstanti, varijabli itd. trebaju biti kurzivom.

11.6 Popisi programa moraju biti numerirani redoslijedom unutar aplikacije. Broj popisa trebao bi se sastojati od oznake prijave i serijskog broja popisa, odvojenih točkom, na primjer: "Listing A.3" je treći popis Dodatka A. Ako projekt (rad) sadrži samo jedan popisu, označen je kao "Listing 1". Pri upućivanju na popis u tekstu PP treba napisati riječ „Upis“ uz naznaku njegovog broja.

11.7 Naslov popisa programa ispisan je istim fontom kao i glavni tekst i nalazi se iznad popisa s lijeve strane, bez uvlačenja, odvojen crticom, iza broja popisa.

Primjer dizajna ispisa programa Ispis A.3 – Program "Izlaz dvodimenzionalnog niza"

mas: niz cijelih brojeva; ( deklaracija dvodimenzionalnog niza) i,j:cijeli broj;

Pravila za prijavu i zahtjevi za sadržaj nastavnih projekata (radova) i završnih kvalifikacijskih radova – 09.1.

(Unos vrijednosti elementa polja) za i:=1 do 5 do

za j:=1 do 5 do readln(mas);

(Ispis vrijednosti elemenata niza) za i:=1 do 5 do start

za j:=1 do 5 do write(" ",mas); writeln;

12 Standardna kontrola

12.1 Standardna kontrola je završna faza u izradi dokumenata za predmetni projekt (rad) i projekt.

12.2 Standardna kontrola mora biti u skladu sa zahtjevima GOST 2.111.

12.3 Završni kvalifikacijski radovi podliježu standardnoj kontroli. Standardnu ​​kontrolu nastavnih projekata (radova) provodi nastavnik prilikom obrane rada. Regulatorna kontrola usmjerena je na pravilno izvođenje tekstualnih i grafičkih dokumenata tečajnih projekata (radova) i tehničkih radova (u daljnjem tekstu dokumenti) u skladu sa zahtjevima standarda GOST, ESKD, ESPD i ESTD.

12.4 Standardnu ​​kontrolu provodi standardni inspektor uzimajući u obzir zahtjeve koji se primjenjuju na ovaj trenutak, standardi i regulatorni i tehnički dokumenti.

12.5 U postupku normativne kontrole obrazloženja nastavnih projekata (radova) i tehničkih radova provjerava se:

– poštivanje pravila registracije u skladu s ovim Pravilnikom;

– izgled PZ;

– cjelovitost projekta u skladu sa projektnim zadatkom;

– naslovna stranica je ispravno ispunjena i prisutni su potrebni potpisi;

– ispravno popunjavanje izjave o projektu (radu);

– prisutnost i ispravnost okvira i glavnih natpisa na svim stranicama;

– isticanje naslova, odjeljaka i pododjeljaka, prisutnost crvenih linija;

– ispravno oblikovanje sadržaja, podudarnost naziva odjeljaka i pododjeljaka u sadržaju s odgovarajućim nazivima u tekstu bilješke;

– ispravno numeriranje stranica, odjeljaka, pododjeljaka, slika, tablica, formula;

– ispravnost crteža;

– ispravno oblikovanje tablica;

– ispravnost dimenzija fizikalnih veličina, njihova usklađenost sa SI;

– usklađenost s normama suvremenog ruskog jezika;

– ispravnost korištenih kratica riječi;

Pravila za prijavu i zahtjevi za sadržaj nastavnih projekata (radova) i završnih kvalifikacijskih radova – 09.1.

– dostupnost i ispravnost pozivanja na korištene izvore;

– dostupnost i ispravnost referenci na regulatorne dokumente;

– ispravnost popisa korištenih izvora;

– ispravan dizajn aplikacije.

12.6 U postupku normativne kontrole grafičkih dokumenata nastavnih projekata (radova) i tehničkih radova provjerava se:

– usklađenost crteža sa zahtjevima važećih standarda;

– izvođenje crteža u skladu sa zahtjevima regulatornih dokumenata;

– usklađenost s formatima, ispravnost njihovog dizajna;

– pravilno crtanje i primjena linija;

– usklađenost s ljestvicama, ispravnost njihove oznake;

– dostatnost slika (vrste, odjeljci, odjeljci), ispravnost njihove oznake i položaja;

– usklađenost simboli elementi u dijagramima i pravila za njihovu provedbu u skladu sa zahtjevima ESKD-a.

12.7. Standardnu ​​kontrolu završnih kvalifikacijskih radova preporučuje se provesti u dvije faze: nakon nacrta (ili u tankim crtama) i konačnog razvoja izvornih dokumenata. Dokumenti koji se razvijaju moraju se podnijeti na regulatornu kontrolu u kompletnom setu, tj. tekstualna (objašnjenje) i grafička dokumentacija (nacrti, specifikacije i sl.).

12.8 Popis komentara standardnog inspektora sastavlja se u slučaju da se kontrola provodi u odsutnosti studenta programera i da on može pogrešno protumačiti bit pogrešaka.

12.9 Dokumenti koje je provjerio normativni inspektor u prisustvu studenta-programera, zajedno s popisom komentara (ako je sastavljen), vraćaju se studentu na ispravke i reviziju. Ako postoje komentari, bilješke inspektora norme se čuvaju dok on ne potpiše dokument. Ako je dokument preradio student, tada se oba primjerka predaju na ponovnu kontrolu: s ocjenama normativnog inspektora i revidirani.

12.10 Dokumenti koji se predaju na potpis normativnom kontroloru moraju imati sve vize za odobrenje, osim vize voditelja odjela. Završne izvornike nastavnih i diplomskih projekata (radova) potpisuje normativ

V stupac "N.cont." glavni natpis.

12.11 Zabranjeno je uvođenje bez znanja normativnog inspektora sve promjene dokumenta nakon što ovaj dokument potpiše i potvrdi regulatorni inspektor.

12.12 Regulatorni inspektor ima pravo, u opravdanim slučajevima, ne potpisati dostavljeni dokument:

– u slučaju nepoštivanja zahtjeva regulatornih dokumenata;

– u nedostatku obveznih potpisa;

- ako se izvodi nemarno;

– u slučaju povrede utvrđene potpunosti.

Pravila za prijavu i zahtjevi za sadržaj nastavnih projekata (radova) i završnih kvalifikacijskih radova – 09.1.

12.13 Normativni kontrolor odgovoran je za usklađenost sa zahtjevima važećih standarda i drugih regulatornih i tehničkih dokumenata u dokumentaciji koja se razvija, zajedno s programerima dokumentacije.

13 Osvrt na WRC

13.1 Za dobivanje dodatne objektivne ocjene završnog kvalifikacijskog rada prijavljenog na obranu, provode vanjsku recenziju završnog kvalifikacijskog rada od strane stručnjaka odgovarajućeg područja.

13.2 Recenzenti završnih kvalifikacijskih radova su visokokvalificirani stručnjaci, čiju osobnu listu utvrđuje diplomski odjel. Kao recenzenti mogu biti uključeni sljedeći: praktičari i nastavnici s drugih sveučilišta.

Uputnicu za reviziju izdaje diplomski odjel čiji se obrazac nalazi u Prilogu T ovih Pravila.

13.3 Recenzent mora biti upoznat sa svim zahtjevima za završni kvalifikacijski rad (ZKR).

13.4 Recenzija se izrađuje u pisanom obliku i sadrži obrazložene ocjene:

– relevantnost teme WRC-a;

– usklađenost sadržaja istraživačko-razvojnog rada sa zadatkom za njegov razvoj;

– ispravnost logičke strukture WRC-a;

– učinkovitost i valjanost dizajnerskih odluka;

– prednosti i nedostatke diplomskog studija, njegovu usklađenost s kvalifikacijskim zahtjevima diplomanta u području studija;

– registracija VKR.

U završnom dijelu prikaza daju se zaključci o cjelovitosti razrade teme, u skladu s postavljenim zadaćama, o teoretskom ili praktičnom značaju istraživačko-razvojnog rada, o mogućem području primjene rezultate istraživačkog rada. Recenzent ocjenjuje rad na ljestvici od četiri stupnja („izvrstan“, „dobar“, „zadovoljava“, „ne zadovoljava“) i ukazuje na mogućnost dodjeljivanja odgovarajuće kvalifikacije studentu.

13.5 Opseg recenzije završnog kvalifikacijskog rada treba biti 2-3 stranice tiskanog ili jasno rukom pisanog teksta. Potpisanu recenziju potrebno je dostaviti Zavodu najkasnije tri dana prije obrane diplomskog rada.

13.6 Recenzija se može sastaviti na memorandumu organizacije (mjesto rada recenzenta), ili na standardnom obrascu propisanom ovim Pravilnikom (Dodatak U) i ovjerena pečatom organizacije, odnosno pečatom kadrovske službe (op. odjel, ured) s naznakom "potpis je ispravan".

13.7 Za obranu diplomskog rada možete dodatno predati recenziju vodeće organizacije koju je naručila komisija za državnu certifikaciju

Pravila za prijavu i zahtjevi za sadržaj nastavnih projekata (radova) i završnih kvalifikacijskih radova – 09.1.

Izveden je VCR. Pregledom treba istaknuti praktičnu vrijednost dobivenih rezultata.

14 Povratne informacije o WRC-u

14.1 Povratnu informaciju o završnom kvalifikacijskom radu sastavlja izravno njegov voditelj. Recenzija treba okarakterizirati diplomski rad s različitih aspekata: sa sadržaja, strukture, cjelovitosti odabrane teme itd.

14.2 Mentor mora u recenziji izraziti svoje objektivno mišljenje o studentovom završnom kvalifikacijskom radu. Pregled posebno mora sadržavati podatke:

– o relevantnosti teme rada;

– o usklađenosti završnog kvalifikacijskog rada sa zahtjevima normi;

– o osposobljenosti studenta za metode prikupljanja, obrade i analize informacija koje se koriste u struci profesionalna djelatnost;

– o osposobljenosti učenika za samostalan rad s izvorima pregledno te pregledno i dosljedno izlaganje gradiva;

– o pozitivnim stranama rada;

– o nedostacima i primjedbama na sadržaj rada i sl.

14.3 Mentorova recenzija završnog kvalifikacijskog rada može sadržavati sugestije u sveukupnoj ocjeni rada.

14.4 Po završetku recenzije mentor donosi zaključak o mogućnosti podnošenja završnog kvalifikacijskog rada na obranu Državnom povjerenstvu za ocjenjivanje.

14.5 Tekst mentorove recenzije diplomskog rada ispisuje se na listovima formata A4 i potpisuje mentor. Obrazac za povratne informacije za WRC predstavljen je u Dodatku F.

15 Izvješće i prezentacija

15.1 Izvješće (govor) je djelo prezentacijske prirode, koje odražava bit WRC-a.

Izvještaj mora dotaknuti relevantnost odabrane teme, teorijski i metodološke osnove rada, kao i sumirati i sumirati rezultate dobivene tijekom studija.

Na kraju izlaganja potrebno je osvrnuti se na praktični značaj rezultata, mogućnost njihove primjene u praksi ili korištenja u nastavi.

15.2 Izvješće je osmišljeno za određeno ograničeno vrijeme govora i neraskidivo je povezano s prezentacijom (handouts).

Pravila za prijavu i zahtjevi za sadržaj nastavnih projekata (radova) i završnih kvalifikacijskih radova – 09.1.

15.3 Prezentacija (handout) priprema se uz pomoć posebni programi(primjerice, Microsoft PowerPoint) vizualni digitalni, tablični i ilustrativni materijal koji je izravno povezan s izvješćem.

15.4 Za prezentaciju se odabire potreban ilustrativni materijal koji se može preuzeti iz teksta rada i iz priloga. To mogu biti tablice, slike, dijagrami, dijagrami, formule itd. Tablice ne smiju biti glomazne, slike ne smiju biti previše detaljne, formule trebaju biti jasne.

Materijal mora ilustrirati sve točke iznesene u izvješću.

15.5 Prezentacija se može prikazati na dva načina:

– korištenje projektora i na stalku;

– koristeći materijale u obliku papirnatih kopija za svakog člana komisije.

Opseg prezentacije može biti od 8 do 12 slajdova.

15.6 Izvješće treba sadržavati samo bit pitanja koje se razmatra, minimum digitalnih podataka, posebne nazive i nabrajanje.

Izvještaj se gradi prema istoj logičkoj shemi kao i projekt (rad), a to su: uvodni dio, glavni dio i zaključci. Uvodni dio treba sadržavati relevantnost i svrhu rada, glavni dio treba u potpunosti otkriti temu koja se razmatra. Zaključci trebaju biti sažeti i nedvosmisleni;

u 1-2 rečenice razmotriti preporuke za rješavanje postavljenih problema.

15.7 Prvi treba biti slajd s temom projekta (rada) i podacima o izvođaču, odnosno: prezime, ime, patronim, grupa, specijalnost (smjer). Preporučljivo je navesti znanstvenog voditelja.

15.8 Nastavni projekt (rad) i diplomski rad predaju se u arhivu zajedno s prezentacijom izrađenom u elektroničkom obliku i snimljenom na digitalnom mediju (npr. CD/DVD).

Pravila za prijavu i zahtjevi za sadržaj nastavnih projekata (radova) i završnih kvalifikacijskih radova – 09.1.

Dodatak A

Pravila za prijavu i zahtjevi za sadržaj nastavnih projekata (radova) i završnih kvalifikacijskih radova – 09.1.

Dodatak B

(naziv fakulteta)

(naziv odjela)

____________ ________________

OBJAŠNJENJE

za predmetni projekt (rad) iz discipline (modula)__

(Ime akademska disciplina(modul))

na temu _________________________________________________________________________________

_____

_______________________

______________________________

Smjer/specijalnost, profil/specijalizacija:

___________ _________________________________________________________________

šifra smjera naziv smjera (specijalnosti)

________________________________________________________________________________

naziv profila (specijalizacija)

Oznaka nastavnog projekta (rada) __________________________ Grupa ________

Rostov na Donu

Dodatak B

MINISTARSTVO OBRAZOVANJA I ZNANOSTI RUSKE FEDERACIJE

FEDERALNI DRŽAVNI PRORAČUN OBRAZOVNA USTANOVA VISOKOG STRUČNOG OBRAZOVANJA

"DON DRŽAVNO TEHNIČKO SVEUČILIŠTE" (DSTU)

Fakultet _______________________________________________________

(naziv fakulteta)

Odjel _________________________________________________________________

(naziv odjela)

glava odjel "______________"

____________ ________________

OBJAŠNJENJE

za diplomski projekt (rad) na temu:

___________________________________________________________________________

___________________________________________________________________________

___________________________________________________________________________

__________________________

(potpis, datum)

Oznaka diplomskog rada _______________________________________

Grupa ______________

Smjer (specijalnost) ___________

___________________________________

(Ime)

Voditelj projekta (posla).

____________________________

(potpis, datum)

(pozicija, I.O.F.)

Konzultanti po sekcijama:

_______________________________

_____________________

(naziv odjeljka)

(potpis, datum)

(pozicija, I.O.F.)

_______________________________

_____________________

(naziv odjeljka)

(potpis, datum)

(pozicija, I.O.F.)

Standardna kontrola

_____________________

(potpis, datum)

(pozicija, I.O.F.)

Rostov na Donu

Pravila za prijavu i zahtjevi za sadržaj nastavnih projekata (radova) i završnih kvalifikacijskih radova – 09.1.

Računalni programi izrađuju se u skladu sa zahtjevima Jedinstvenog sustava programske dokumentacije (USPD). ESPD je skup GOST-ova koji utvrđuju pravila za dizajn, sadržaj i strukturu programskih dokumenata.
Ovaj način rada sadrži izvatke iz ESPD-a. Potpune informacije mogu se dobiti izravno iz GOST-ova.

Kratki algoritam za izradu programa

Na slici su ukratko prikazani algoritam izrade programa i vrste programskih dokumenata. Postupak registracije je detaljnije opisan u nastavku.

Izrada programskog dokumenta

Programski dokument - dokument koji sadrži podatke potrebne za razvoj, proizvodnju, održavanje i rad programa.

Svaki pojedinačni programski dokument sastavljen je u skladu sa (zajedničkim za sve ESPD dokumente) zahtjevima GOST 19.101-77, GOST 19.103-77, GOST 19.104-78, GOST 19.105-78, GOST 19.106-78, GOST 19.604-78 ( detaljniji opis ovih GOST-ova slijedi u nastavku) i GOST-a za određeni programski dokument.

Opći zahtjevi za programske dokumente. GOST 19.105 - 78

Zahtjevi za tiskane programske dokumente. GOST 19.106 - 78

GOST 19.106-78 utvrđuje pravila za izvršavanje programskih dokumenata za tiskanu metodu izvršenja.

Važno je napomenuti da se ovaj GOST ne odnosi na programski dokument "Programski tekst".

Materijali programskog dokumenta mora biti u sljedećem nizu:

  • Naslovni dio:
    • list odobrenja (ne ulazi u ukupan broj listova dokumenta);
    • naslovna stranica (prva stranica dokumenta);
  • Informativni dio:
    • anotacija;
    • sadržaj;
  • Glavni dio:
    • tekst dokumenta (sa slikama, tablicama i sl.);
    • aplikacije;
    • popis pojmova, popis kratica, popis slika, popis tablica, predmetno kazalo, popis referentnih dokumenata;
    • dio zapisivanja promjena:
    • promijeniti upisni list.

Anotacija označava izdanje programa i ukratko opisuje svrhu i sadržaj dokumenta. Ako se dokument sastoji od više dijelova, u napomeni se navodi ukupan broj dijelova. Sadržaj dokumenta nalazi se na zasebnoj (numeriranoj) stranici (stranicama) iza napomene, s naslovom "SADRŽAJ", nije numeriran kao odjeljak i uključen je u ukupan broj stranica dokumenta.

Oblikovanje teksta:

  • Programski dokument se izvodi na jednoj strani lista, u dva intervala; dopušteno u jednom ili jednom i pol intervalu.
  • Sažetak se stavlja na posebnu (numeriranu) stranicu s naslovom „SAŽETAK” i nije numeriran kao odjeljak.
  • Naslovi odjeljaka pišu se velikim slovima i postavljaju simetrično u odnosu na desni i lijevi rub teksta.
  • Naslovi pododjeljaka pišu se iz odlomka malim slovima (osim prvog velikog).
  • Rastavljanje riječi u naslovima nije dopušteno. Na kraju naslova nema točke.
  • Udaljenost između naslova i sljedećeg teksta, kao i između naslova odjeljaka i pododjeljaka, treba biti jednaka:
    • pri izvršavanju dokumenta tipkanjem - dva intervala.
  • Za odjeljke i pododjeljke, čiji je tekst napisan na istoj stranici s tekstom prethodnog odjeljka, razmak između posljednjeg reda teksta i sljedećeg naslova treba biti jednak:
    • pri izvršavanju dokumenta tipkanom metodom - tri tipkana intervala.
  • Odjeljke, pododjeljke, paragrafe i podstavke treba numerirati arapskim brojevima s točkom.
  • Unutar odjeljka moraju postojati kontinuirani brojevi za sve pododjeljke, paragrafe i podstavke uključene u ovaj odjeljak.
  • Numeracija pododjeljaka uključuje broj odjeljka i redni broj pododjeljka uključenog u ovaj odjeljak, odvojene točkom (2.1; 3.1 itd.).
  • Ako postoje odjeljci i pododjeljci, uz broj pododjeljka iza točke dodaje se redni broj točke i podtočke (3.1.1, 3.1.1.1 itd.).
  • Tekst dokumenta treba biti kratak, jasan, isključujući mogućnost pogrešnog tumačenja.
  • Pojmovi i definicije moraju biti jedinstveni i u skladu s utvrđenim standardima, a u nedostatku - općeprihvaćeni u znanstvenoj i stručnoj literaturi, te biti navedeni u popisu pojmova.
  • Potrebna objašnjenja teksta dokumenta mogu se dati u fusnotama.
  • Bilješka je označena brojem sa zagradom postavljenom na razini gornjeg ruba fonta, na primjer: "ispisni uređaj2)..." ili "papir5)".
  • Ako se bilješka odnosi na jednu riječ, znak fusnote stavlja se neposredno uz tu riječ, a ako se odnosi na rečenicu u cjelini, onda na kraju rečenice. Tekst fusnote stavlja se na kraj stranice i od glavnog teksta odvaja crtom duljine 3 cm na lijevoj strani stranice.
  • Ilustracije, ako ih u pojedinom dokumentu ima više, numeriraju se arapskim brojevima kroz cijeli dokument.
  • Formule u dokumentu, ako ih ima više, numeriraju se arapskim brojevima, a broj se stavlja na desnoj strani stranice, u zagradi na razini formule.
  • Značenje simbola i numeričkih koeficijenata uključenih u formulu mora biti navedeno neposredno ispod formule. Značenje svakog znaka ispisuje se u novom retku redoslijedom kojim su navedeni u formuli. Prvi redak prijepisa treba započeti riječju "gdje", bez dvotočke iza nje.
  • U programskim dokumentima dopušteno je pozivanje na standarde (osim na standarde poduzeća), tehničke specifikacije i druge dokumente (na primjer, dokumente državnih nadzornih tijela, pravila i propise Državnog odbora za izgradnju SSSR-a). Pri upućivanju na norme i tehničke specifikacije navedena je njihova oznaka.
  • Treba se pozvati na dokument u cjelini ili na njegove dijelove (uz naznaku i naziv dokumenta, broj i naziv odjeljka ili priloga). Kod ponavljanja referenci na odjeljak ili aplikaciju navodi se samo broj.
  • Bilješke uz tekst i tablice navode samo referentne podatke i podatke s objašnjenjima.
  • Jedna bilješka nije numerirana. Iza riječi "Napomena" stavite točku.
  • Nekoliko bilješki treba redom numerirati arapskim brojevima s točkom. Iza riječi “Napomena” staviti dvotačku.
  • Nisu dopuštene kratice riječi u tekstu i natpisi ispod ilustracija.
  • Ilustrirani materijal, tablice ili popratni tekst mogu se prikazati u obliku priloga.
  • Svaka prijava mora započeti na novoj stranici s naznakom "DODATAK" u gornjem desnom kutu i imati tematski naslov koji se ispisuje simetrično u odnosu na tekst velikim slovima.

GOST sadrži uzorak lista koji označava polja, mjesta za numeriranje stranica i kod.