Pravidla pro přípravu programové dokumentace. Registrace programové dokumentace v souladu s espd, espd Registrace programové dokumentace v souladu s GOST

programy pro technické prostředky a další programy, Obecná charakteristika vstupní a výstupní informace, dále požadavky a podmínky organizačního, technického a technologického charakteru apod.).

Například: Program je spuštěn osobní počítač(PC) typu IBM PC/AT. Pro práci v interaktivním režimu se používá displej, klávesnice a myš. Pro podporu grafického režimu je vyžadován adaptér EGA (VGA). Vstupní data jsou uložena na disketách a/nebo pevných discích. Program běží pod OS...

Příloha k popisu může obsahovat referenční materiály (ilustrace, tabulky, grafy, příklady atd.)

A nezapomeňte uvést název spouštěcího modulu a také popis celého postupu pro volání a načítání systému

Například: Program se stáhne zadáním příkazový řádek DOSový název spouštěcího modulu je SBM80N.EXE s případným uvedením názvu datového souboru.

TEXT PROGRAMU (GOST 19 401-78)

Požadavky na návrh programového textu jsou poměrně jednoduché a pro kompetentního programátora přirozené. Hlavní věcí, kterou je třeba se řídit při vytváření tohoto dokumentu, je, že text programu by měl být čitelný.

Stále je povinné sestavit informační část - anotace a obsah.

Hlavní část dokumentu by měla tvořit texty jedné nebo více sekcí, které jsou pojmenovány.

Text každého souboru programu začíná „hlavičkou“, která označuje:

· název programu,

· datum vytvoření programu,

· číslo verze,

· datum poslední úpravy.

Komentáře jsou povinné, stejně jako přísné dodržování pravidel pro odsazení. Pamatujte, že i neschopnost vytvořit softwarovou dokumentaci lze ospravedlnit. Ale ošklivý text programu – nikdy. Odkazy na to, že tento text je srozumitelný i samotnému autorovi, nebereme vážně. Neměla by být ostuda dávat texty programu ke čtení dalším lidem.

PROGRAM A METODIKA TESTU (GOST 19.301-79)

Tento dokument obsahuje popis toho, co a jak je třeba udělat, abyste se ujistili (a přesvědčili zákazníka), že program funguje správně. Ve skutečnosti je tento dokument rozhodující pro přijetí

testy. Dobře navržený testovací program a metodika je klíčem k podpisu akceptačního certifikátu, tzn. věc, za kterou jsi vynaložil tolik úsilí a času.

Formálně se tento GOST používá k vývoji plánovacích dokumentů a provádění zkušebních prací k posouzení připravenosti a kvality softwarového systému. Dokument obsahuje popis objektu a účelu testování, požadavky na program a dokumentaci programu, testovací nástroje a postupy a také popisy testovacích případů.

Komponenty tohoto dokumentu jsou snadněji a přehledněji popsány ve formě příkladů.

Testovací objekt

Příklad: Testovacím objektem je program ..., určený pro

Účel testování

Příklad: Kontrola spolehlivosti programu.

Požadavky na program

Příklad: Provoz programu by neměl vést k poruše (fatálnímu narušení systému). Organizace dialogu by měla zajistit ochranu před zadáním nesprávných údajů. Program by měl poskytovat diagnostiku stavu systému a zprávy o případných chybách, které se vyskytly...atd.

Požadavky na dokumentaci k softwaru

Příklad: Obsah softwarové dokumentace prezentované během testování:

· popis programu (GOST 19.402-78);

· testovací program a metodika (GOST 19.301-79);

· text programu (GOST 19.401-78).

Testovací prostředky a postup

Příklad: Program pracuje v souladu s provozními podmínkami operačního systému MS DOS (verze ne nižší než 3.0) na PC, jako je IBM PC/AT, i na kompatibilních. K provozu je také nutný adaptér.

Postup testu:

1. Program je spuštěn….

2. Vyberte...

3. Stiskněte...

4. Postupně vybrané...

Testovací případy

Příklad: Pro testování jsou navrženy ..., jejichž popisy jsou obsaženy v souborech ... Obsah testovacích souborů a výsledky programu jsou uvedeny v příloze 1.

A nakonec se podívejme na poslední standard ESPD, který nás zajímá, který se nazývá

POŽADAVKY NA TIŠTĚNÉ SOFTWAROVÉ DOKUMENTY (GOST 19.106-78)

Norma stanovuje pravidla pro provádění programových dokumentů pro počítače, komplexy a systémy bez ohledu na jejich účel a rozsah a zamýšlené normy ESPD.

Obecné požadavky. Je nutné zadávat jednotlivá slova, vzorce, symboly (ručně kreslicím písmem), písmena latinské a řecké abecedy, jakož i kreslit schémata a kresby v programových dokumentech vytvořených strojopisem, strojem a rukopisem, černým inkoustem. nebo inkoust.

Překlepy a grafické nepřesnosti zjištěné během procesu provádění lze opravit vymazáním špatně provedené části textu (kresby) a aplikací opraveného textu (grafiky) na stejný list strojopisem nebo černým inkoustem, v závislosti na způsobu provedení. dokument.

Poškození listů dokumentů, skvrny a stopy po neúplně smazaném textu (grafice) nejsou povoleny.

Programové dokumenty jsou vypracovány na listech A4. Až na

· Je přijatelné tisknout na listy A3;

· Při výrobě dokumentu na stroji jsou přípustné odchylky ve velikosti listů odpovídající formátům A4 a A3, dané možnostmi použitého technické prostředky; na listech formátu A4 a A3, zajištěných výstupními charakteristikami zařízení pro výstup dat, při strojové výrobě dokumentu;

· Při výrobě dokumentu typografickou metodou je možné použít listy typografických formátů.

Materiály programového dokumentu jsou uspořádány v následujícím pořadí:

· titulní díl:

- schvalovací list (nezapočítává se do celkového počtu listů dokumentu);

- titulní strana (první strana dokumentu);

· informační část:

Anotace;

- obsah;

· hlavní část:

- text dokumentu (s obrázky, tabulkami atd.);

- seznam pojmů a jejich definice;

- seznam zkratek;

Aplikace;

- předmětový rejstřík;

- seznam referenčních dokumentů;

· změnit logovací část:

- změnit registrační list.

Konstrukce dokumentu. V případě potřeby je povoleno rozdělit dokument na části. Rozdělení na části se provádí na úrovni ne nižší než sekce. Každá část se vyplňuje samostatně a na konci obsahu první části by měly být uvedeny názvy zbývajících částí.

Do dokumentu je povoleno zahrnout části textu programu, formátované v souladu s pravidly jazyka, ve kterém je text programu napsán.

Abstrakt je zveřejněn na samostatná stránka(strany), opatřené záhlavím „ABSTRAKT“, očíslované a zahrnuté do obsahu dokumentu.

Text každého dokumentu je v případě potřeby rozdělen na odstavce a odstavce na pododstavce, bez ohledu na to, zda je dokument rozdělen na části, oddíly a pododdíly či nikoli.

Nadpisy oddílů jsou psány velkými písmeny a umístěny symetricky vzhledem k pravému a levému okraji textu. Nadpisy pododdílů se píší z odstavce malá písmena(kromě prvního hlavního města). Dělení slov v nadpisech není povoleno. Na konci názvu není žádná tečka. Doporučuje se začít každou sekci na novém listu.

Oddíly, pododdíly, odstavce a pododstavce by měly být číslovány arabskými číslicemi s tečkou. Sekce musí mít pořadové číslo (1, 2 atd.)

Text dokumentu. Text dokumentu by měl být krátký, jasný, vylučující možnost nesprávného výkladu. Termíny a definice musí být jednotné a v souladu se zavedenými normami a v případě jejich absence - obecně uznávané ve vědecké a technické literatuře a musí být uvedeny v seznamu termínů.

Potřebná vysvětlení k textu dokumentu lze uvést v poznámkách pod čarou. Poznámka pod čarou je označena číslem se závorkou umístěnou na úrovni horního okraje písma.

Odkazuje-li poznámka pod čarou na jediné slovo, je znak poznámky pod čarou umístěn přímo u tohoto slova, pokud však odkazuje na větu jako celek, pak na konec věty. Text poznámky pod čarou je umístěn na konci stránky a oddělen od hlavního textu 3 cm dlouhou čarou nakreslenou na levé straně stránky.

Ilustrace. Ilustrace mohou být umístěny v textu dokumentu a (nebo) v přílohách. Ilustrace, pokud jsou k dispozici tento dokument více než jeden, jsou v celém dokumentu číslovány arabskými číslicemi.

V přílohách jsou ilustrace v každé příloze číslovány v pořadí stanoveném pro hlavní text dokumentu. Odkazy na obrázky jsou uvedeny podle typu: "Obr. 12" nebo "(Obr. 12)". Ilustrace mohou mít tematický název a text popisku vysvětlující obsah ilustrace.

Vzorce. Vzorce v dokumentu, pokud jich je více, jsou číslovány arabskými číslicemi, číslo je umístěno s pravá strana stránky, v závorkách na úrovni vzorce. V rámci celého dokumentu nebo jeho částí, pokud je dokument rozdělen na části, mají vzorce průběžné číslování.

Odkazy v textu na pořadové číslo vzorce jsou uvedeny v závorkách, například: „ve vzorci (3)“. Při rozdělování dokumentu na části se číslo dílu umístí před pořadové číslo vzorce a oddělí se od poslední tečky, například: „ve vzorci (1.4)“.

Význam symbolů obsažených ve vzorci musí být uveden přímo pod vzorcem. Význam každého znaku se vytiskne na nový řádek v pořadí, v jakém jsou uvedeny ve vzorci. První řádek přepisu musí začínat slovem „kde“ bez dvojtečky za ním.

Odkazy. V dokumentech zásad jsou povoleny odkazy na normy a další dokumenty. Měl by být uveden odkaz na dokument jako celek nebo na jeho části (s uvedením označení a názvu dokumentu, čísla a názvu oddílu nebo přílohy).

Je povoleno uvést pouze označení dokumentu a (nebo) oddílů bez uvedení jejich jmen. Odkazy na jednotlivé pododstavce, odstavce a ilustrace jiného dokumentu nejsou povoleny. V rámci dokumentu jsou povoleny odkazy na odstavce, ilustrace a jednotlivé podsekce.

Poznámky Poznámky k textu a tabulkám uvádějí pouze referenční a vysvětlující údaje. Jedna poznámka není očíslována. Poté za slovo „Poznámka“ vloží tečku. Několik poznámek by mělo být očíslováno v pořadí pomocí arabských číslic s tečkou. A v tomto případě se za slovo „Poznámka“ umístí dvojtečka. Text poznámek lze tisknout pouze v jednom intervalu.

Zkratky. Zkratky slov v textu a nápisy pod obrázky nejsou povoleny, s výjimkou:

· zkratky zavedené v GOST 2.316-68 a obecně přijímané v ruském jazyce;

· zkratky používané k označení programů a jejich částí

A operační režimy, v jazycích pro řízení úloh, v nástrojích pro nastavení programu atd., označené latinkou

abeceda.

Aplikace. Ilustrovaný materiál, tabulky nebo podpůrný text mohou být uvedeny ve formě příloh. Přílohy jsou vypracovány jako pokračování tohoto dokumentu na následujících stranách nebo jsou vydány jako samostatný dokument.

Každá aplikace musí začínat nová stránka s označením vpravo horní roh slova „Aplikace“ a mají tematický název. Pokud je v dokumentu více než jedna příloha, jsou všechny přílohy očíslovány arabskými číslicemi (bez znaku „Ne“), například:

Dodatek 1, Dodatek 2 atd.

Při vydávání žádosti jako samostatného dokumentu by mělo být na titulní straně pod názvem dokumentu uvedeno slovo „Příloha“, a pokud existuje více žádostí, mělo by být uvedeno i její pořadové číslo.

Uživatelská příručka dokumentace specifikace softwarového produktu

Uživatelská dokumentace odkazuje na dokumentaci, která poskytuje koncovému uživateli informace o instalaci a provozu softwarového balíčku. Informace o obalu se týkají informací zobrazených na vnějším obalu softwarového balíčku. Jeho účelem je poskytnout potenciálním kupcům prvotní informace o softwarovém balíčku.

Uživatelská dokumentace softwaru vysvětluje uživatelům, jak musí postupovat při žádosti tento program. Je nezbytné, pokud program zahrnuje jakoukoli interakci s uživateli. Tato dokumentace zahrnuje dokumenty, které uživatele vedou při instalaci programu s příslušným nastavením pro prostředí aplikace, při používání programu k řešení jeho problémů a při správě programu (například když tento software spolupracuje s

S jiné systémy). Tyto dokumenty částečně řeší problémy údržby softwaru, ale neřeší problémy s nimi související

S modifikace programů.

V V tomto ohledu je třeba rozlišovat dvě kategorie uživatelů: běžní uživatelé programu a správci. Běžný uživatel programu(koncový uživatel) používá program k řešení svých problémů (ve své předmětové oblasti). To by mohl být konstruktér technické zařízení, nebo pokladní, která pomocí tohoto programu prodává jízdenky na vlak. Možná nezná mnoho detailů fungování počítače nebo principů programování. Správce programu (správce systému) řídí používání programu běžnými uživateli a zajišťuje údržbu softwaru, která nesouvisí s úpravou programu. Může například regulovat přístupová práva k programu mezi běžnými uživateli, komunikovat s dodavateli programu nebo provádět určité akce pro udržení programu v chodu, pokud je součástí jiného systému.

Složení uživatelské dokumentace závisí na uživatelích, na které je zaměřena, a na způsobu použití dokumentů. Publikum zde označuje kontingent uživatelů

ke kterému je potřeba určitá uživatelská dokumentace. Úspěšný uživatelský dokument výrazně závisí na přesné identifikaci cílové skupiny, pro kterou je určen. Uživatelská dokumentace by měla obsahovat informace potřebné pro každé publikum. Způsob použití dokumentu odkazuje na metodu, která určuje, jak se tento dokument používá. Obvykle uživatel potřebuje velké softwarových systémů buď jsou vyžadovány dokumenty ke studiu softwaru (použijte jako návod) nebo k objasnění některých informací (použijte jako referenční knihu).

Obecný funkční popis softwaru. Dává stručný popis funkčnost softwarový nástroj. Určeno pro uživatele, kteří se musí rozhodnout, jak moc daný softwarový nástroj potřebují.

Průvodce instalací softwaru. Navržený pro správci systému. Musí podrobně předepisovat, jak instalovat systémy v konkrétním prostředí. Musí obsahovat popis strojově čitelného média, na kterém je software dodáván, soubory představující software a minimální požadavky na konfiguraci hardwaru.

Pokyny pro používání softwaru. Určeno pro běžné uživatele. Obsahuje potřebné informace o používání softwaru, uspořádané ve formě vhodné pro studium.

Referenční kniha o použití softwaru. Určeno pro běžné uživatele. Obsahuje potřebné informace o použití softwaru, uspořádané ve formě vhodné pro selektivní vyhledávání jednotlivých částí.

Průvodce správou softwaru. Určeno pro systémové administrátory. Měl by popisovat zprávy generované při interakci softwaru s jinými systémy a jak na tyto zprávy reagovat. Kromě toho, pokud softwarový nástroj používá systémový hardware, může tento dokument vysvětlit, jak tento hardware udržovat.

Vývoj uživatelské dokumentace začíná ihned po vytvoření externího popisu. Kvalita této dokumentace může významně rozhodnout o úspěchu programu. Měl by být poměrně jednoduchý a uživatelsky přívětivý (jinak by se tento software vůbec nevyplatilo vytvořit). Proto, i když jsou návrhy uživatelských dokumentů vytvářeny hlavními vývojáři softwaru, k vytváření konečných verzí se často používají profesionální techničtí spisovatelé.

Pro zajištění kvality uživatelské dokumentace byla navíc vypracována řada norem, které předepisují postup tvorby této dokumentace, formulují požadavky na jednotlivé typy uživatelských dokumentů a určují jejich strukturu a obsah.

1.4 Příručka programátora

Systémová dokumentace popisuje software z hlediska jeho vývoje.

Tato dokumentace je nezbytná, pokud software zahrnuje studium toho, jak je strukturován (navržen) a aktualizaci svých programů. Jak bylo uvedeno, údržba je neustálý vývoj. Pokud je tedy nutné modernizovat softwarový nástroj, je do této práce zapojen speciální tým vývojářů a správců. Tento tým se bude muset vypořádat se stejnou dokumentací, která definovala činnost týmu prvotních (hlavních) vývojářů softwaru - jen s tím rozdílem, že tato dokumentace pro vývojový tým bude zpravidla cizí (vznikla jiným týmem). Vývojový tým údržby bude muset prostudovat tuto dokumentaci, aby porozuměl struktuře a procesu vývoje softwaru, který je upgradován, a provést v této dokumentaci nezbytné změny, které se do značné míry opakují. technologických postupů, s jehož pomocí vznikl původní software.

Dokumentaci softwarové podpory lze rozdělit do dvou skupin:

1. dokumentace definující strukturu softwarových programů a datových struktur a technologii jejich vývoje;

2. dokumentaci, která vám pomůže provádět změny v softwaru.

Dokumentace první skupiny obsahuje finální dokumenty každé technologické etapy vývoje softwaru. Zahrnuje následující dokumenty.

Externí popis softwaru (dokument s požadavky). Popis architektury softwaru

architektura), včetně externí specifikace každého z jejích programů.

U každého softwarového programu popis jeho modulární struktury včetně externí specifikace každého v něm obsaženého modulu.

Pro každý modul - jeho specifikace a popis jeho struktury

(popis designu).

Texty modulů ve zvoleném programovacím jazyce (výpis zdrojového kódu programu).

Ověřovací dokumenty, které popisují, jak byla stanovena platnost

každý softwarový program a jak byly informace o zajištění spojeny se softwarovými požadavky.

Ověřovací dokumenty zahrnují především testovací dokumentaci (návrh testu a popis testovací sady), ale mohou také zahrnovat výsledky jiných typů testování softwaru, například důkazy o vlastnostech programu.

Dokumentace druhé skupiny obsahuje

Průvodce údržbou systému, který popisuje známé problémy se softwarem, popisuje, které části systému jsou závislé na hardwaru a softwaru a jak je při jeho návrhu zohledněn vývoj softwaru.

Běžným problémem při údržbě softwaru je zajistit, aby všechny jeho reprezentace držely krok (zůstaly konzistentní), když se software změnil. Aby tomu napomohlo, musí být vztahy a závislosti mezi dokumenty a jejich částmi zachyceny v databázi správy konfigurace.

Závěr Rychlý nárůst složitosti a velikosti moderních systémů

programů při současném zvýšení odpovědnosti za vykonávané funkce prudce zvýšily požadavky zákazníků a uživatelů na jejich kvalitu a bezpečnost používání. Osvědčený prostředek pro zajištění vysoké efektivity a kvality fungování programů a softwarových systémů jsou dokumentační standardy vyvinuté za účasti zástupců předních společností v oboru.

V Rusku v oblasti poskytování životní cyklus a kvalitou komplexních softwarových balíků se používá především skupina zastaralých norem GOST, které zaostávají za světovou úrovní o 5-10 let.

Během několika posledních let bylo vytvořeno mnoho norem ISO, které regulují procesy životního cyklu a produkty. software a databáze, které mohou sloužit jako základ pro systémy zajišťování kvality softwarových produktů. Pro zlepšení kvality produktů je nutné znát a správně používat všechny standardy softwarové dokumentace.

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

Systém technické dokumentace pro automatizované řídicí systémy

GOST 24.207-80

POŽADAVKY NA OBSAH SOFTWAROVÝCH DOKUMENTŮ
Systém technické dokumentace pro počítačové řídicí systémy. Požadavky na obsah dokumentů v softwaru

Výnosem Státního výboru pro normy SSSR ze dne 14. května 1980 č. 2101 bylo stanoveno datum zavedení

od 01.01.1981

Tato norma platí pro technická dokumentace pro automatizované řídicí systémy (ACS) všech typů, vyvinuté pro všechny úrovně řízení (kromě národních), a stanovuje požadavky na obsah dokumentů zahrnutých v souladu s GOST 24.101-80 jako součást softwarové dokumentace v projektech ACS.

1. OBECNÁ USTANOVENÍ

1.1. Dokumentace k softwaru je určena pro:

  • popsat konstrukční řešení softwaru v dokumentu „Popis softwaru ACS“.
  • stanovit požadavky na program (soubor programů) v dokumentu „ Technický úkol»;
  • popisovat řešení, která zajišťují údržbu, výrobu a provoz programu (souboru programů) v dokumentech „Vysvětlivka“, „Popis aplikace“, „Popis programu“, „Specifikace“, „Průvodce programem“, „Příručka provozovatele“. Průvodce“, „Text programu“, „Formulář“, „Postup a zkušební metody“;
  • pro kontrolu funkčnosti programu (sady programů) v dokumentu „Popis testovacího případu“.

1.2. Při vývoji dokumentů pro části automatizovaného řídicího systému je obsah částí každého dokumentu omezen na rámec odpovídající části.

1.3. V závislosti na účelu a specifických vlastnostech vytvořených automatizovaných řídicích systémů je dovoleno zahrnout do dokumentů další oddíly, jejichž obsahové požadavky nejsou touto normou stanoveny. Absence konstrukčních řešení u části dokumentu je zaznamenána v příslušné části s potřebnými vysvětlivkami.

1.4. Požadavky na obsah dokumentů „Technické specifikace“, „Vysvětlivka“, „Popis aplikace“, „Specifikace“, „Návod k obsluze“, „Text programu“, „Formulář“, „Postup a metodika zkoušky“ stanoví 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 a GOST 19.301-79.

(Změněné vydání, dodatek č. 1).

2. POŽADAVKY NA OBSAH DOKUMENTŮ

2.1. Popis softwaru ACS

2.1.1. Dokument musí obsahovat úvodní část a oddíly:

  • struktura softwaru;
  • hlavní funkce částí softwaru;
  • metody a nástroje vývoje softwaru;
  • operační systém;
  • nástroje zmocnění operační systém.

2.1.2. Úvodní část by měla obsahovat základní informace o technické, informační a další typy podpory automatizovaného řídicího systému nezbytné pro vývoj software, případně odkaz na příslušné dokumenty projektu automatizovaného řídicího systému.

2.1.3. Část „Struktura softwaru“ by měla obsahovat seznam částí softwaru s uvedením jejich vztahů a zdůvodněním pro identifikaci každé z nich.

2.1.4. Sekce „Hlavní funkce částí softwaru“ by měla obsahovat podsekce, ve kterých je pro každou část softwaru uveden účel a popis hlavních funkcí.

(Změněné vydání, dodatek č. 1).

2.1.5. Část „Metody a nástroje pro vývoj softwaru“ by měla obsahovat seznam programovacích metod a nástrojů pro vývoj softwaru automatizovaného řídicího systému s uvedením částí softwaru, při jejichž vývoji by měly být použity vhodné metody a nástroje.

2.1.6. Sekce "Operační systém" by měla obsahovat:

  • název, označení a stručný popis zvoleného operačního systému a jeho verze, ve které budou vyvíjené programy spouštěny, s odůvodněním volby a uvedením zdrojů, pokud jsou uvedeny Detailní popis vybraná verze;
  • název manuálu, podle kterého má být vygenerována vybraná verze operačního systému;
  • požadavky na možnost generování zvolené verze operačního systému.

2.1.7. Sekce „Nástroje rozšiřující možnosti operačního systému“ by měla obsahovat podsekce, ve kterých byste pro každý použitý nástroj rozšiřující možnosti operačního systému měli uvést:

  • název, označení a stručný popis produktu s odůvodněním potřeby jeho použití a uvedením zdroje, který uvádí podrobný popis vybraného produktu;
  • název příručky, podle které by měl být použitý produkt konfigurován pro konkrétní aplikaci;
  • požadavky na nastavení použitého nástroje.

2.2. Popis programu

2.2.2. U programu (souboru programů) získaného pomocí dříve vyvinutého softwaru by měl být dokument „Popis programu“ doplněn o část „Nastavení softwaru“.

2.2.3. Část „Konfigurace softwaru“ by měla obsahovat:

  • název, označení používaného softwaru, popis postupů potřebných k jejich konfiguraci nebo odkazy na provozní dokumentaci těchto nástrojů;
  • seznam prvků použitého softwaru nezbytných k získání programu (souboru programů);
  • popis nastavení v jazyce uvedeném v provozní dokumentaci k použitému softwaru.

2.3. Příručka programátora

2.3.1. Dokument o složení sekcí a jejich obsahu musí odpovídat GOST 19.504-79 a navíc musí obsahovat část „Informace o formě prezentace programu (souboru programů).

2.3.2. Část „Informace o formě prezentace pořadu (souboru pořadů)“ musí obsahovat údaje o médiu, na kterém je pořad nahrán, o obsahu a systému kódování informací zaznamenaných na nosiči, jakož i údaje potřebné pro čtení informací z média.

2.3.3. Pro program (soubor programů), který lze přizpůsobit podmínkám konkrétní aplikace, obsahuje dokument „Programmer's Guide“ části:

  • struktura programu;
  • nastavení programu;
  • další funkce;
  • zprávy systémovému programátorovi.

2.3.4. Je povoleno pro program (soubor programů), který lze přizpůsobit podmínkám konkrétní aplikace, namísto oddílů uvedených v článku 2.3.3 vytvořit samostatný dokument „Příručka programátora systému“, který splňuje požadavky GOST. 19,503-79.

2.4. Popis testovacího případu

2.4.1. Dokument musí obsahovat části:

  • jmenování;
  • počáteční údaje;
  • výsledky výpočtů;
  • kontrola programu (souboru programů).

2.4.2. Sekce „Účel“ by měla obsahovat seznam parametrů a stručný popis funkce, která je implementována programem (souborem programů), který je testován testovacím příkladem.

2.4.3. Sekce „Počáteční data“ musí obsahovat popis výchozích dat pro testování programu (souboru programů) s uvedením výchozích dat. Je povoleno prezentovat zdrojová data ve formě tiskového výstupu z ADCP.

2.4.4. Sekce „Výsledky výpočtu“ by měla obsahovat výsledky zpracování počátečních dat programem (souborem programů), které umožňují vyhodnotit správné provedení testovaných funkcí a hodnotu testovaných parametrů. Je povoleno prezentovat výsledky výpočtu formou tisku z ADCP.

2.4.5. Část „Kontrola programu (sady programů)“ by měla obsahovat:

  • popis složení technických prostředků nezbytných pro provoz programu (souboru programů), případně odkaz na příslušné programové dokumenty;
  • popis postupů pro generování počátečních dat pro kontrolu programu (souboru programů), volání testovaného programu (souboru programů) a získání výsledků výpočtů;
  • popis činností operátora při přípravě počátečních dat a testování programu (souboru programů) pomocí testovacího příkladu.
* Reedice (květen 1986) se změnou č. 1, schválená v srpnu 1985 (IUS 11-85).
Na vrchol

GOST 19.105-78* (Všeobecné požadavky na programové dokumenty)

Z tohoto GOST dostávámeobecné požadavky na přípravu programových dokumentů.Níže jsou uvedeny nejdůležitější sekce.

  • Tato norma stanoví obecné požadavky na přípravu programových dokumentů pro počítače, komplexy a systémy bez ohledu na jejich účel a rozsah a stanovené normami Jednotný systém softwarová dokumentace (ESPD) pro jakýkoli způsob spouštění dokumentů na různých paměťových médiích.
  • Programový dokument se skládá z následujících konvenčních částí:
    • titul;
    • informační;
    • základní;
    • registrace změn.
  • Titulní část tvoří schvalovací list a titulní strana. Pravidla pro vypracování schvalovacího listu a titulní stránky jsou stanovena v souladu s GOST 19.104-78.
  • Informační část by se měl skládat z abstraktu a obsahu.
    • Potřeba zahrnout informační část do různých typů programových dokumentů je stanovena příslušnými standardy ESPD pro tyto dokumenty.
    • Anotace poskytuje informace o účelu dokumentu a souhrn jeho hlavní část.
    • Obsah zahrnuje seznam záznamů o konstrukčních prvcích hlavní části dokumentu, z nichž každý obsahuje:
      • označení konstrukčního prvku (číslo sekce, podsekce atd.);
      • název konstrukčního prvku;
      • adresa konstrukčního prvku na paměťovém médiu (například číslo stránky, číslo souboru atd.).
  • Složení a struktura hlavní části programového dokumentu jsou stanoveny standardy ESPD pro příslušné dokumenty.
  • Změna logovací části(musí být přítomen v každém programovém dokumentu)
    • Každá změna v programovém dokumentu je v této části zaznamenána v souladu s požadavky GOST 19.603-78.
Na vrchol
==================================
GOST 19.106-78* (Všeobecné požadavky na programové dokumenty vyrobené v tištěné podobě
cesta)
Z tohoto GOST dostáváme hlavní pravidla pro způsob tiskuprogramové dokumenty. Níže jsou uvedeny nejdůležitější sekce.
  • Tato norma stanoví pravidla pro provádění programových dokumentů pro počítače, komplexy a systémy bez ohledu na jejich účel a rozsah použití a stanovená standardy Jednotného systému programové dokumentace (USPD) pro tištěný způsob provádění.
  • Norma se nevztahuje na programový dokument „Programový text“.
  • Složení a struktura programového dokumentu je stanovena v souladu s GOST 19.105-78.
  • Programový dokument je spuštěnna jedné straně listu ve dvou intervalech; povoleno v jednom nebo jeden a půl intervalech.
  • Programové dokumenty vypracovávají:
    • na listech formátu A4 (GOST 2.301-68) - při přípravě dokumentu strojopisem nebo rukopisem (formulář 1). Kreslení na listy A3 je povoleno.


  • Materiály programového dokumentu jsou uspořádány v následujícím pořadí:
    • titulní díl:
      • schvalovací list (nezapočítává se do celkového počtu listů dokumentu);
      • titulní strana (první strana dokumentu);
    • informační část:
      • anotace;
      • obsah;
    • hlavní část:
      • text dokumentu (s obrázky, tabulkami atd.);
      • aplikace;
      • seznam pojmů, seznam zkratek, seznam obrázků, seznam tabulek, věcný rejstřík, seznam referenčních dokumentů;
    • změnit logovací část:
      • změnit registrační list.
  • Abstrakt je umístěn na samostatné (číslované) stránce s nadpisem „ABSTRAKT“ a není číslován jako oddíl.
    • Anotace označuje vydání programu a stručně nastiňuje účel a obsah dokumentu. Pokud se dokument skládá z více částí, je celkový počet částí uveden v anotaci.
  • Obsah dokumentu je umístěn na samostatnou (číslovanou) stránku (stránky) za anotací, opatřenou nadpisem „OBSAH“, nečíslovanou jako oddíl a zahrnutou do celkového počtu stran dokumentu.
  • Nadpisy oddílů jsou psány velkými písmeny a umístěny symetricky vzhledem k pravému a levému okraji textu.
  • Nadpisy pododdílů se píší z odstavce malými písmeny (kromě prvního velkého).
  • Dělení slov v nadpisech není povoleno. Na konci názvu není žádná tečka.
  • Vzdálenost mezi nadpisem a následujícím textem a také mezi nadpisy oddílů a pododdílů by měla být rovna:
    • při provádění dokumentu strojopisem - dva intervaly.
  • U oddílů a pododdílů, jejichž text je napsán na stejné stránce s textem předchozího oddílu, by měla být vzdálenost mezi posledním řádkem textu a následujícím nadpisem rovna:
    • při provádění dokumentu strojopisnou metodou - tři strojopisné intervaly.
  • Oddíly, pododdíly, odstavce a pododstavce by měly být číslovány arabskými číslicemi s tečkou.
  • V rámci oddílu musí být průběžné číslování všech pododdílů, odstavců a pododstavců obsažených v tomto oddílu.
  • Číslování podsekcí zahrnuje číslo sekce a pořadové číslo podsekce zahrnuté v této sekci oddělené tečkou (2.1; 3.1 atd.).
  • Pokud existují oddíly a pododdíly, za tečku se k číslu pododdílu připojí pořadové číslo odstavce a článku (3.1.1, 3.1.1.1 atd.).

Příklad struktury textu programového dokumentu a číslování jeho oddílů, pododdílů, odstavců a pododstavců.

  • Text dokumentu by měl být krátký, jasný, vylučující možnost nesprávného výkladu.
  • Termíny a definice musí být jednotné a v souladu se zavedenými normami a v případě jejich absence - obecně uznávané ve vědecké a technické literatuře a musí být uvedeny v seznamu termínů.
  • Potřebná vysvětlení k textu dokumentu lze uvést v poznámkách pod čarou.
    • Poznámka pod čarou je označena číslem se závorkou umístěnou na úrovni horního okraje písma, například: „tiskové zařízení 2) ...“ nebo „papír 5)“.
    • Odkazuje-li poznámka pod čarou na jediné slovo, je znak poznámky pod čarou umístěn přímo u tohoto slova, pokud však odkazuje na větu jako celek, pak na konec věty. Text poznámky pod čarou je umístěn na konci stránky a oddělen od hlavního textu 3 cm dlouhou čarou nakreslenou na levé straně stránky.
  • Ilustrace, pokud je jich v daném dokumentu více, jsou v celém dokumentu číslovány arabskými číslicemi.
  • Vzorce v dokumentu, pokud jich je více, jsou číslovány arabskými číslicemi, číslo je umístěno na pravé straně stránky v závorce na úrovni vzorce.
  • Význam symbolů a číselných koeficientů obsažených ve vzorci musí být uveden přímo pod vzorcem. Význam každého znaku se vytiskne na nový řádek v pořadí, v jakém jsou uvedeny ve vzorci. První řádek přepisu by měl začínat slovem „kde“, bez dvojtečky za ním.
  • V programových dokumentech jsou povoleny odkazy na normy (s výjimkou podnikových norem), technické specifikace a další dokumenty (například dokumenty orgánů státního dozoru, pravidla a předpisy Státního stavebního výboru SSSR). Při odkazu na normy a technické specifikace je uvedeno jejich označení.
  • Měl by být uveden odkaz na dokument jako celek nebo na jeho části (s uvedením označení a názvu dokumentu, čísla a názvu oddílu nebo přílohy). Při opakování odkazů na sekci nebo aplikaci je uvedeno pouze číslo.
  • Poznámky k textu a tabulkám uvádějí pouze referenční a vysvětlující údaje.
    • Jedna poznámka není očíslována. Za slovem „Poznámka“ vložte tečku.
    • Několik poznámek by mělo být očíslováno v pořadí pomocí arabských číslic s tečkou. Za slovo „Poznámka“ vložte dvojtečku.
  • Zkratky slov v textu a nápisy pod ilustracemi nejsou povoleny.
  • Ilustrovaný materiál, tabulky nebo podpůrný text mohou být uvedeny ve formě příloh.
  • Každá přihláška musí začínat na nové stránce slovem „PŘÍLOHA“ v pravém horním rohu a musí mít tematický nadpis, který je psán symetricky k textu velkými písmeny.(nakonec k vytvoření projektu potřebujeme pouze registrační list změn).
    • Tato norma stanoví pravidla pro provádění změn v programových dokumentech stanovených standardy Unified System of Program Documentation (USPD) a tištěných.
    Vzhledem k značnému množství informací v této GOST a kvůli úspoře místa na této stránce doporučuji si ji prohlédnout sami GOST 19.604-78* . Příklad připraveného designu"změnit registrační list"Můžete si jej prohlédnout v libovolném programovém dokumentu uvedeném v části STÁHNOUT

    Na vrchol
    ==================================

Pravidla pro registraci a požadavky na obsah ročníkové práce

Vydání 2

projekty (práce) a závěrečné kvalifikační práce

strana 39 ze 73

Montážní výkres montážní jednotky

pod číslem 8, součástí produktu 1

PK.760108.000 SB

Montážní výkres samostatné sestavy

jednotky 4

PK.760004.000 SB

Celkový pohled na výkres samostatné sestavy

jednotky 4

PK.760004,000 VO

Součástí je výkres dílu číslo 16

montážní celek 8 produktů 1

Součástí je výkres dílu číslo 120

samostatná montážní jednotka 4

Schéma elektrického zapojení produktu 1

PK.760100.000 E3

Kinematické schéma zapojení, samostatné

žádná montážní jednotka 4

PK.760400.000 K3

Specifikace montážní jednotky 8 produkt 1

10 Příprava technologických podkladů

10.1 Technologické dokumenty kurzových projektů (prací) a závěrečných kvalifikačních prací jsou zpracovány v souladu s požadavky norem ESTD.

10.2 Technologické dokumenty by měly obsahovat:

– titulní strana, navržená v souladu s GOST 3.1105-84 „ESTD. Forma a pravidla pro přípravu dokumentů obecný účel"(Formulář 2a).

– mapa trasy vydaná v souladu s GOST 3.1118-82 „ESTD. Formuláře a pravidla pro přípravu map tras“;

– obráběcí operační karty a provozní

výpočetní a technologické mapy pro technologické operace na CNC strojích - v souladu s GOST 3.1404-86 „ESTD. Formuláře a pravidla pro přípravu podkladů pro technologické procesy a řezné operace“;

– zámečnické provozní karty, instalatérské a montážní práce v souladu s GOST 3.1407-86 „ESTD. Formuláře a požadavky na vyplnění a zpracování podkladů pro technologické procesy (operace) specializované na způsoby montáže“;

– načrtnout mapy (v případě potřeby) podle GOST 3.1105-84 a GOST 3.1128-93 „ESTD. Hlavní pravidla zpracování grafických technologických podkladů“;

– karty provozního řízení procesů podle GOST 3,1502-85 „ESTD. Formuláře a pravidla pro přípravu podkladů pro technickou kontrolu“;

– další technologické dokumenty (v případě potřeby nebo podle rozhodnutí projektového manažera).

10.3 Výkresy oprav se provádějí v souladu s pravidly stanovenými GOST 2.604-88 „Výkresy oprav“.

10.4 Technologická dokumentace musí být svázána

přímo ve vysvětlivce kurzu (projektu) práce nebo po aplikacích, specifikacích a seznamech prvků. Technologické dokumenty mají své vlastní číslování.

11 Příprava programových dokumentů

11.1 Dokumenty různých problémových oblastí vypracované v projektech kurzů (prácích) a závěrečných kvalifikačních pracích musí mít následující formát:

– programové dokumenty - v souladu s požadavky ESPD,

– dokumenty pro automatizovaný systémřízení - dle státních standardů systému technologické dokumentace pro automatizované systémy řízení. 11.2 Programové dokumenty (výpisy programů) musí obsahovat:

– text programu, navržený v souladu s GOST 19.401;

– popis programu, vyrobený v souladu s GOST 19.402;

– popis poznámky uvedený v souladu s GOST 19.502;

– další programové dokumenty (v případě potřeby).

11.3 Výpisy programů jsou umístěny v aplikacích s povinnými odkazy na ně v PP.

11.4 Programový kód může být doplněn komentáři. Při návrhu inzerátů se doporučuje použít font Courier New, velikost – 12 pt, řádkování – jednoduché. Doporučuje se oddělit sémantické bloky prázdnými řádky a také vizuálně označit vnořené struktury pomocí odsazení.

11.5 Klíčová slova a komentáře ve výpisech programů mohou být psány kurzívou. V hlavním textu PP by měly být názvy knihoven, podprogramů, konstant, proměnných atd. psány kurzívou.

11.6 Seznamy programů musí být v aplikaci postupně očíslovány. Číslo zápisu by se mělo skládat z označení přihlášky a pořadového čísla zápisu oddělených tečkou, např.: „Zápis A.3“ je třetí zápis Přílohy A. Pokud projekt (dílo) obsahuje pouze jeden zápis výpis, je označen jako „Zápis 1“. Když se v textu PP odkazuje na výpis, mělo by být uvedeno slovo „Zápis“ označující jeho číslo.

11.7 Název výpisu programu je ve stejném fontu jako hlavní text a je umístěn nad výpisem vlevo, bez odsazení, oddělený pomlčkou, za číslem výpisu.

Příklad návrhu výpisu programu Výpis A.3 – Program „Výstup dvourozměrného pole“

mas:array of integer; ( deklarace dvourozměrného pole) i,j:integer;

Pravidla pro přihlašování a požadavky na obsah kurzových projektů (prácí) a závěrečných kvalifikačních prací – 09.1

(Zadání hodnot prvků pole) pro i:=1 až 5 do

for j:=1 až 5 do readln(mas);

(Tisk hodnot prvků pole) pro i:=1 až 5 začněte

for j:=1 až 5 do write(" ",mas); writeln;

12 Standardní ovládání

12.1 Standardní kontrola je konečnou fází ve vývoji dokumentů pro projekt (práce) kurzu a projekt.

12.2 Standardní ovládání musí odpovídat požadavkům GOST 2.111.

12.3 Závěrečné kvalifikační práce podléhají standardní kontrole. Standardní kontrolu seminárních prací (prácí) provádí vyučující při obhajobě práce. Regulační kontrola je zaměřena na správné provedení textových a grafických dokumentů kurzových projektů (prací) a technických prací (dále jen dokumenty) v souladu s požadavky norem GOST, ESKD, ESPD a ESTD.

12.4 Standardní kontrolu provádí standardní inspektor s přihlédnutím k příslušným požadavkům tento moment, normy a regulační a technické dokumenty.

12.5 V procesu normativní kontroly vysvětlivek k projektům (pracím) a technickým pracím se kontroluje:

– dodržování pravidel registrace v souladu s těmito pravidly;

– vzhled PZ;

– úplnost návrhu v souladu s projektovým zadáním;

– titulní strana je správně vyplněna a jsou přítomny požadované podpisy;

– správné vyplnění výkazu projektu (práce);

– přítomnost a správnost rámečků a hlavních nápisů na všech stránkách;

– zvýraznění nadpisů, oddílů a pododdílů, přítomnost červených čar;

– správné formátování obsahu, shoda názvů sekcí a podsekcí v obsahu s odpovídajícími názvy v textu poznámky;

– správné číslování stránek, oddílů, pododdílů, obrázků, tabulek, vzorců;

– správnost výkresů;

– správné formátování tabulek;

– správnost rozměrů fyzikálních veličin, jejich soulad s SI;

– dodržování norem moderního ruského jazyka;

– správnost použitých zkratek slov;

Pravidla pro přihlašování a požadavky na obsah kurzových projektů (prácí) a závěrečných kvalifikačních prací – 09.1

– dostupnost a správnost odkazů na použité zdroje;

– dostupnost a správnost odkazů na regulační dokumenty;

– správnost seznamu použitých zdrojů;

– správný návrh aplikace.

12.6 V procesu normativní kontroly grafických dokumentů kurzových projektů (prací) a technických prací se kontroluje:

– soulad výkresů s požadavky současných norem;

– provádění výkresů v souladu s požadavky regulačních dokumentů;

– dodržování formátů, správnost jejich provedení;

– správné kreslení a aplikace čar;

– dodržování měřítek, správnost jejich označení;

– dostatek obrázků (typů, řezů, řezů), správnost jejich označení a umístění;

– dodržování symboly prvky ve schématech a pravidla pro jejich realizaci v souladu s požadavky ESKD.

12.7. Standardní kontrolu závěrečných kvalifikačních prací se doporučuje provádět ve dvou fázích: po návrhu (nebo v tenkých řádcích) a konečném zpracování původních dokumentů. Vypracovávané dokumenty musí být předloženy k regulační kontrole v kompletní sadě, tzn. textová (vysvětlivka) a grafická dokumentace (výkresy, specifikace atd.).

12.8 Seznam připomínek standardního inspektora je sestaven v případě, že kontrola probíhá v nepřítomnosti vývojáře studenta a může být z jeho strany nesprávně interpretována podstata chyb.

12.9 Dokumenty zkontrolované normativním inspektorem za přítomnosti studenta zpracovatele se spolu se seznamem připomínek (pokud je sestaven) vrací studentovi k opravě a přepracování. Pokud existují připomínky, poznámky inspektora normy jsou uchovány, dokud dokument nepodepíše. Pokud je dokument přepracován studentem, pak jsou obě kopie předloženy k opětovné kontrole: se známkami normativního inspektora a revidovanou.

12.10 Dokumenty předkládané k podpisu normativnímu kontrolorovi musí mít všechna schvalovací víza, kromě víza vedoucího katedry. Konečné originály ročníkových a diplomových projektů (prácí) podepisuje normativní inspektor

PROTI sloupec "N.pokrač." hlavní nápis.

12.11 Je zakázáno zavádět bez vědomí normativního inspektora jakékoli změny dokumentu poté, co byl tento dokument podepsán a potvrzen regulačním inspektorem.

12.12 Regulační inspektor má právo v odůvodněných případech poskytnutý dokument nepodepsat:

– v případě nedodržení požadavků regulačních dokumentů;

– při absenci povinných podpisů;

- při neopatrném provedení;

– v případě porušení stanovené úplnosti.

Pravidla pro přihlašování a požadavky na obsah kurzových projektů (prácí) a závěrečných kvalifikačních prací – 09.1

12.13 Normativní kontrolor je odpovědný za soulad s požadavky současných norem a dalších regulačních a technických dokumentů ve vyvíjené dokumentaci spolu s tvůrci dokumentace.

13 Recenze WRC

13.1 Pro získání dodatečného objektivního posouzení závěrečné kvalifikační práce předložené k obhajobě je provedeno externí posouzení závěrečné kvalifikační práce odborníky v příslušném oboru.

13.2 Recenzenti závěrečných kvalifikačních prací jsou vysoce kvalifikovaní odborníci, jejichž osobní seznam určuje absolventská katedra. Jako recenzenti mohou být zapojeni: odborníci z praxe a učitelé z jiných univerzit.

Požadavek k přezkoumání vydává absolventská katedra, jehož podoba je uvedena v příloze T tohoto řádu.

13.3 Recenzent musí být obeznámen se všemi požadavky na závěrečnou kvalifikační práci (GQR).

13.4 Recenze je vypracována písemně a obsahuje odůvodněné hodnocení:

– relevantnost tématu WRC;

– soulad obsahu výzkumné a vývojové práce s úkolem pro její rozvoj;

– správnost logické struktury WRC;

– účinnost a platnost rozhodnutí o návrhu;

– výhody a nevýhody absolventské školy, její soulad s kvalifikačními požadavky absolventa ve studijním oboru;

– registrace VKR.

V závěrečné části posudku jsou uvedeny závěry o úplnosti rozpracování tématu, v souladu se stanovenými úkoly, o teoretickém či praktickém významu výzkumné a vývojové práce, o možné oblasti využití výsledky výzkumné práce. Recenzent práci hodnotí na čtyřstupňové škále („výborně“, „dobře“, „uspokojivě“, „nevyhovuje“) a uvede možnost přidělit studentovi náležitou kvalifikaci.

13.5 Objem revize závěrečné kvalifikační práce by měl být 2-3 strany tištěného nebo zřetelně ručně psaného textu. Podepsaný posudek musí být odevzdán na katedru nejpozději tři dny před obhajobou práce.

13.6 Posudek lze provést na hlavičkovém papíře organizace (pracoviště recenzenta), nebo na standardním formuláři upraveném těmito Pravidly (Příloha U) a ověřeném razítkem organizace, případně razítkem personálního oddělení (obecné oddělení, úřad) s označením „podpis je správný“.

13.7 K obhajobě práce můžete dodatečně předložit posudek od vedoucí organizace pověřené komisí pro státní certifikaci

Pravidla pro přihlašování a požadavky na obsah kurzových projektů (prácí) a závěrečných kvalifikačních prací – 09.1

VCR bylo provedeno. Přezkum by měl zdůraznit praktickou hodnotu získaných výsledků.

14 Zpětná vazba k WRC

14.1 Zpětnou vazbu na závěrečnou kvalifikační práci zpracovává přímo její vedoucí. Recenze by měla charakterizovat práci z různých hledisek: od obsahu, struktury, úplnosti zvoleného tématu atd.

14.2 Vedoucí práce musí v posudku vyjádřit svůj objektivní názor na závěrečnou kvalifikační práci studenta. Recenze musí obsahovat zejména tyto informace:

– o relevanci tématu práce;

– o souladu závěrečné kvalifikační práce s požadavky norem;

– o dovednostech studenta v metodách sběru, zpracování a analýzy informací používaných v oboru odborná činnost;

- o schopnosti studenta samostatně pracovat s prameny jasně a srozumitelně a důsledně prezentovat látku;

– o pozitivních aspektech práce;

– o nedostatcích a připomínkách k obsahu práce atp.

14.3 Posudek vedoucího závěrečné kvalifikační práce může obsahovat návrhy týkající se celkového hodnocení práce.

14.4 V závěru posudku učiní školitel závěr o možnosti předložení závěrečné kvalifikační práce k obhajobě Státní atestační komisi.

14.5 Text posudku vedoucího práce je vytištěn na listech A4 a podepsán vedoucím práce. Formulář zpětné vazby pro WRC je uveden v příloze F.

15 Zpráva a prezentace

15.1 Reportáž (projev) je dílo prezentačního charakteru, odrážející podstatu WRC.

Zpráva se musí dotýkat relevance zvoleného tématu, teoretické a metodologické základy práce, stejně jako shrnout a shrnout výsledky získané během studia.

V závěru prezentace je třeba reflektovat praktický význam výsledků, možnost jejich realizace v praxi či využití ve výuce.

15.2 Zpráva je určena pro danou omezenou řečnickou dobu a je neoddělitelně spojena s prezentací (doslovami).

Pravidla pro přihlašování a požadavky na obsah kurzových projektů (prácí) a závěrečných kvalifikačních prací – 09.1

15.3 Prezentace (doslova) je připravena s pomocí speciální programy(například Microsoft PowerPoint) vizuální digitální, tabulkový a ilustrační materiál, který přímo souvisí s reportem.

15.4 Pro prezentaci je vybrán potřebný ilustrační materiál, který lze převzít jak z textu práce, tak z příloh. Mohou to být tabulky, obrázky, diagramy, diagramy, vzorce atd. Tabulky by neměly být objemné, obrázky by neměly být příliš podrobné, vzorce by měly být jasné.

Materiál musí ilustrovat všechny body uvedené ve zprávě.

15.5 Prezentaci lze zobrazit dvěma způsoby:

– pomocí projektoru a na stojanu;

– pomocí letáků ve formě papírových kopií pro každého člena komise.

Objem prezentace může být od 8 do 12 snímků.

15.6 Zpráva by měla obsahovat pouze podstatu zvažované problematiky, minimum digitálních dat, speciální názvy a výčet.

Zpráva je sestavena podle stejného logického schématu jako projekt (práce), tedy: úvodní část, hlavní část a závěry. Úvodní část by měla obsahovat relevanci a účel práce, hlavní část by měla plně odhalit zvažované téma. Závěry by měly být stručné a jednoznačné;

v 1-2 větách zvažte doporučení pro řešení nastolených problémů.

15.7 První by měl být snímek s tématem projektu (dílem) a podrobnostmi o interpretovi, tj. příjmení, jméno, patronymie, skupina, specializace (směr). Je vhodné uvést vědeckého supervizora.

15.8 Projekt (práce) a diplomová práce se odevzdávají do archivu spolu s prezentací v elektronické podobě a nahranou na digitální médium (např. CD/DVD).

Pravidla pro přihlašování a požadavky na obsah kurzových projektů (prácí) a závěrečných kvalifikačních prací – 09.1

Příloha A

Pravidla pro přihlašování a požadavky na obsah kurzových projektů (prácí) a závěrečných kvalifikačních prací – 09.1

Dodatek B

(název fakulty)

(název oddělení)

____________ ________________

VYSVĚTLIVKA

za projekt kurzu (práce) v oboru (modulu)__

(Název akademická disciplína(modul))

Na téma _________________________________________________________________________

_____

_______________________

______________________________

Směr/specialita, profil/specializace:

___________ _________________________________________________________________

směrové kódové jméno směru (specialita)

________________________________________________________________________________

název profilu (specializace)

Označení projektu (práce) kurzu __________________________ Skupina ________

Rostov na Donu

Dodatek B

MINISTERSTVO ŠKOLSTVÍ A VĚDY RUSKÉ FEDERACE

FEDERÁLNÍ STÁTNÍ ROZPOČET VZDĚLÁVACÍ INSTITUCE VYSOKÉHO ODBORNÉHO VZDĚLÁVÁNÍ

"DON STÁTNÍ TECHNICKÁ UNIVERZITA" (DSTU)

Fakulta _________________________________________________________

(název fakulty)

Oddělení ______________________________________________________________

(název oddělení)

Hlava oddělení "______________"

____________ ________________

VYSVĚTLIVKA

za absolventský projekt (práci) na téma:

___________________________________________________________________________

___________________________________________________________________________

___________________________________________________________________________

__________________________

(datum podpisu)

Označení absolventského projektu ________________________________

Skupina _______________

Směr (specialita) ___________

___________________________________

(Název)

Vedoucí projektu (práce).

____________________________

(datum podpisu)

(pozice, I.O.F.)

Konzultanti podle sekcí:

_______________________________

_____________________

(název sekce)

(datum podpisu)

(pozice, I.O.F.)

_______________________________

_____________________

(název sekce)

(datum podpisu)

(pozice, I.O.F.)

Standardní ovládání

_____________________

(datum podpisu)

(pozice, I.O.F.)

Rostov na Donu

Pravidla pro přihlašování a požadavky na obsah kurzových projektů (prácí) a závěrečných kvalifikačních prací – 09.1

Počítačové programy jsou vypracovány v souladu s požadavky Jednotného systému programové dokumentace (USPD). ESPD je soubor GOST, který stanoví pravidla pro návrh, obsah a strukturu programových dokumentů.
Tento návod obsahuje výňatky z ESPD. Kompletní informace lze získat přímo od společnosti GOST.

Stručný algoritmus návrhu programu

Na obrázku je stručně znázorněn algoritmus návrhu programu a typy programových dokumentů. Postup registrace je podrobněji popsán níže.

Příprava programového dokumentu

Programový dokument - dokument obsahující informace potřebné pro vývoj, výrobu, údržbu a provoz programů.

Každý jednotlivý programový dokument je vypracován v souladu s (společnými pro všechny dokumenty ESPD) požadavky GOST 19.101-77, GOST 19.103-77, GOST 19.104-78, GOST 19.105-78, GOST 19.106-78, GOST 19.604-78 ( podrobnější popis těchto GOST je uveden níže) a GOST pro konkrétní programový dokument.

Obecné požadavky na programové dokumenty. GOST 19.105 - 78

Požadavky na tištěné programové dokumenty. GOST 19.106 - 78

GOST 19.106-78 stanoví pravidla pro provádění programových dokumentů pro tištěný způsob provádění.

Je důležité si uvědomit, že tento GOST se nevztahuje na programový dokument „Text programu“.

Materiály programového dokumentu musí být v následujícím pořadí:

  • Titulní část:
    • schvalovací list (nezapočítává se do celkového počtu listů dokumentu);
    • titulní strana (první strana dokumentu);
  • Informační část:
    • anotace;
    • obsah;
  • Hlavní část:
    • text dokumentu (s obrázky, tabulkami atd.);
    • aplikace;
    • seznam pojmů, seznam zkratek, seznam obrázků, seznam tabulek, věcný rejstřík, seznam referenčních dokumentů;
    • změnit logovací část:
    • změnit registrační list.

Anotace označuje vydání programu a stručně nastiňuje účel a obsah dokumentu. Pokud se dokument skládá z více částí, je celkový počet částí uveden v anotaci. Obsah dokumentu je umístěn na samostatnou (číslovanou) stránku (stránky) za anotací, opatřenou nadpisem „OBSAH“, nečíslovanou jako oddíl a zahrnutou do celkového počtu stran dokumentu.

Formátování textu:

  • Programový dokument se spustí na jedné straně listu ve dvou intervalech; povoleno v jednom nebo jeden a půl intervalech.
  • Abstrakt je umístěn na samostatné (číslované) stránce s nadpisem „ABSTRAKT“ a není číslován jako oddíl.
  • Nadpisy oddílů jsou psány velkými písmeny a umístěny symetricky vzhledem k pravému a levému okraji textu.
  • Nadpisy pododdílů se píší z odstavce malými písmeny (kromě prvního velkého).
  • Dělení slov v nadpisech není povoleno. Na konci názvu není žádná tečka.
  • Vzdálenost mezi nadpisem a následujícím textem a také mezi nadpisy oddílů a pododdílů by měla být rovna:
    • při provádění dokumentu strojopisem - dva intervaly.
  • U oddílů a pododdílů, jejichž text je napsán na stejné stránce s textem předchozího oddílu, by měla být vzdálenost mezi posledním řádkem textu a následujícím nadpisem rovna:
    • při provádění dokumentu strojopisnou metodou - tři strojopisné intervaly.
  • Oddíly, pododdíly, odstavce a pododstavce by měly být číslovány arabskými číslicemi s tečkou.
  • V rámci oddílu musí být průběžné číslování všech pododdílů, odstavců a pododstavců obsažených v tomto oddílu.
  • Číslování podsekcí zahrnuje číslo sekce a pořadové číslo podsekce zahrnuté v této sekci oddělené tečkou (2.1; 3.1 atd.).
  • Pokud existují oddíly a pododdíly, za tečku se k číslu pododdílu připojí pořadové číslo odstavce a článku (3.1.1, 3.1.1.1 atd.).
  • Text dokumentu by měl být krátký, jasný, vylučující možnost nesprávného výkladu.
  • Termíny a definice musí být jednotné a v souladu se zavedenými normami a v případě jejich absence - obecně uznávané ve vědecké a technické literatuře a musí být uvedeny v seznamu termínů.
  • Potřebná vysvětlení k textu dokumentu lze uvést v poznámkách pod čarou.
  • Poznámka pod čarou je označena číslem se závorkou umístěnou na úrovni horního okraje písma, například: „tiskové zařízení2)...“ nebo „papír5)“.
  • Odkazuje-li poznámka pod čarou na jediné slovo, je znak poznámky pod čarou umístěn přímo u tohoto slova, pokud však odkazuje na větu jako celek, pak na konec věty. Text poznámky pod čarou je umístěn na konci stránky a oddělen od hlavního textu 3 cm dlouhou čarou nakreslenou na levé straně stránky.
  • Ilustrace, pokud je jich v daném dokumentu více, jsou v celém dokumentu číslovány arabskými číslicemi.
  • Vzorce v dokumentu, pokud jich je více, jsou číslovány arabskými číslicemi, číslo je umístěno na pravé straně stránky v závorce na úrovni vzorce.
  • Význam symbolů a číselných koeficientů obsažených ve vzorci musí být uveden přímo pod vzorcem. Význam každého znaku se vytiskne na nový řádek v pořadí, v jakém jsou uvedeny ve vzorci. První řádek přepisu by měl začínat slovem „kde“, bez dvojtečky za ním.
  • V programových dokumentech jsou povoleny odkazy na normy (s výjimkou podnikových norem), technické specifikace a další dokumenty (například dokumenty orgánů státního dozoru, pravidla a předpisy Státního stavebního výboru SSSR). Při odkazu na normy a technické specifikace je uvedeno jejich označení.
  • Měl by být uveden odkaz na dokument jako celek nebo na jeho části (s uvedením označení a názvu dokumentu, čísla a názvu oddílu nebo přílohy). Při opakování odkazů na sekci nebo aplikaci je uvedeno pouze číslo.
  • Poznámky k textu a tabulkám uvádějí pouze referenční a vysvětlující údaje.
  • Jedna poznámka není očíslována. Za slovem „Poznámka“ vložte tečku.
  • Několik poznámek by mělo být očíslováno v pořadí pomocí arabských číslic s tečkou. Za slovo „Poznámka“ vložte dvojtečku.
  • Zkratky slov v textu a nápisy pod ilustracemi nejsou povoleny.
  • Ilustrovaný materiál, tabulky nebo podpůrný text mohou být uvedeny ve formě příloh.
  • Každá přihláška musí začínat na nové stránce slovem „PŘÍLOHA“ v pravém horním rohu a musí mít tematický nadpis, který je psán symetricky k textu velkými písmeny.

GOST obsahuje vzorový list, který označuje pole, místa pro číslování stránek a kód.