Katedra počítačov a informatiky, Fakulta elektrotechniky a informatiky, TU Košice

Štandard KPI 11, verzia 4

 

 

 

Dokumentácia pre technické prostriedky

a pre integrované prostriedky

 

Obsah

 

1         Dokumentácia pre technické prostriedky....... 1

1.1        Obsah dokumentácie 1

1.2        Typová osnova sprievodnej správy 2

1.3        Pokyny na vyhotovenie dokumentácie 2

2         Dokumentácia pre integrované produkty........... 2

2.1             Dokumenty pre vypracovanie integrovaného produktu...... 2

2.2             Dokumenty pre realizáciu integrovaného produktu...... 2

2.3             Dokumenty pre používanie integrovaného produktu...... 2

3       Pokyny na popis médií....... 2

 

1       Dokumentácia pre technické prostriedky

 

1.1      Obsah dokumentácie

Prototypová dokumentácia obsahuje nasledovné časti konštrukčnej, výrobnej a používateľskej dokumentácie:

 

1	KV	v	výkres	výkres súčiastok, modulov a vyšších zostáv v mierke a na normalizovanom formáte - väzba na 2.
2	KV	t	rozpiska materiálu	komponenty príslušnej hierarchickej úrovne
3	K	w	funkčná schéma	pre funkčné celky podľa potreby vysvetliť činnosť v sprievodnej  správe - semestrálneho projektu, diplomovej práce a pod.
4	K	w	bloková schéma	vychádza z označovaní na častiach 5, 7 a 8
5	K	w	obvodová schéma(y)	pre všetky hierarchické úrovne
6	V	v	*obrazec(ce) plošných spojov
7	V	t	*zoznam vonkajších spojov	názvy signálov a typy vonkajších prepojení
8	V	t	zoznam signálov na konektoroch	pin, názov signálu konektorov každého modulu
9	KV	s	**programovacie tabuľky	formáty súboru pre naprogramovanie
10	KV	te	popis činnosti	popis podľa blokovej a obvodovej schémy
11	V	s	*vŕtací predpis
12	V	te	oživovací predpis	použité prostriedky a postup - väzba na 1., 5., 10.
13	KV	t	rekapitulačný list	zoznam všetkých dokumentov príslušnej hierarchickej úrovne),
14	P	te	návod na použitie	textový dokument obsahujúci návod použitia výrobku, predpis pre profilaktickú údržbu, súpis náhradných súčiastok, bezpečnostný predpis a pod.
15	K	te	sprievodná správa	textový dokument, ktorý obyčajne obsahuje aj časti: 3,4,10

Druh dokumentácie:

                                K                konštrukčná,

                                V                výrobná,

                                P                používateľská.

Druh dokumentácie:

                                v                výkres v mierke podľa STN,

                                w                výkres bez mierky,

                                t                tabuľka,

                                te                textový dokument,

                                s                 súbor.

 

Časti označené * sa nevytvárajú pre technické prostriedky slúžiace iba pre overenie teoretického návrhu, tzv. funkčné vzory.

Časti označené ** sa vytvárajú len pri použití pamätí typu ROM, PROM, EPROM ,  a pod.

 

1.2      Typová osnova sprievodnej správy

1.Analýza podmienok riešenia úlohy

2.Návrh koncepcie riešenia

3.Popis riešenia

3.1.Popis riešenia, výpočet

3.2.Popis architektúry

4.Konštrukčný návrh

       v podkapitolách popis modulov a blokov

5.Náväznosť na iné produkty

6.Súpis použitých konštrukčných a bezpečnostných noriem

7.Zhodnotenie riešenia

8.Literatúra

9.Súpis príloh

 

Poznámky:

Zoznam použitej literatúry musí byť v súlade s normami STN. Podľa záznamu musí byť prameň jednoznačne identifikovateľný. Je potrebné uvádzať aj pramene z INTERNET-u. Pri internetovských citáciách je potrebné uviesť autora dokumentu (pokiaľ je uvedený), názov dokumentu, jeho internetovskú adresu a dátum získania dokumentu.

Prílohy tvoria dokumenty v zmysle kapitoly 1.1. Prílohu tiež tvoria média (disketa(y), resp. CD disky), ktoré musia obsahovať text sprievodnej správy vrátane obrázkov a všetky prílohy ako výsledok spracovania s použitím počítača. Média musia byť opatrené štítkom s popisom podľa kap. 3.

 

 

1.3      Pokyny na vyhotovenie dokumentácie

 

1.               Rozmery výkresov podľa platných noriem A4-A0.

2.               Adresná rohová tabuľka vpravo dole.

3.               Používajú sa tri druhy čiar:

tenká 1b 0,25          (popisy, pomocné čiary),

zosilnená 2b 0,5          (obrysy, spoje),

hrubá 3-4b 0,7-1 (zbernice, pozície komponentov).

4.               Zosilnenou čiarou kresliť všetky súčiastky a spoje, tenkou popis, hrubá len na zbernice.

5.               Odporúča sa používať tzv. jednočiarové kreslenie.

6.               Kreslenie funkčnej a obvodovej schémy podľa STN 01 3303  a STN 01 3304.

7.               Kreslenie pasívnych súčiastok podľa normy STN IEC  617-2-12.

8.               Vstupy sa povoľujú kresliť zľava a zhora, výstupy sprava  a zdola.

9.               Výkresy dosiek s plošnými spojmi a požiadavky na plošné  spoje uvádzajú normy STN 01 3396 - 98, STN 35 9002 - 3 a  STN IEC 3263 a STN 33 9011.

10.            Rozpiska materiálov sa uvádza s presnou špecifikáciou  súčiastok (i s prípadnými alternatívnymi náhradami).

11.            Návrhy, knižničné prvky, programovacie súbory, technologické súbory DPS, príp. iné nutné súbory musia byť obsiahnuté na diskete, ktorá je súčasťou príloh dokumentu.

 

Konštrukčne-výrobná dokumentácia musí mať označenie na čele obalu.

 

2       Dokumentácia pre integrované produkty

 

Integrovaný produkt obsahuje kombináciu realizácie programových aj technických prostriedkov (fyzickej časti). Dokumenty sa delia na tri základné skupiny:

dokumenty pre vypracovanie integrovaného produktu,

dokumenty pre realizáciu integrovaného produktu,

dokumenty pre používanie integrovaného produktu.

 

 

2.1      Dokumenty pre vypracovanie integrovaného produktu

 

Dokument definuje technické zadanie úlohy. U diplomových prác je to obsah textu kapitoly "Formulácia úlohy". Dokument obsahuje:

- názov zadania,

- podmienky riešenia,

- náväznosti na iné úlohy,

- účel a oblasť  použitia integrovaného produktu,

- východzie údaje pre postup spracovania.

 

2.2      Dokumenty pre realizáciu integrovaného produktu

 

1/ Dokumenty pre realizáciu programovej časti integrovaného produktu

Dokumentácia je reprezentovaná Systémovou príručkou (základná časť), ktorá predstavuje popis realizácie programového produktu, a výpismi zdrojových textov jednotlivých programov. Je určená tiež pre pracovníkov, ktorí majú byť schopní realizovať ďalšie úpravy integrovaného produktu, odstraňovať chyby a pod. Systémová príručka nadväzuje na Konštrukčno-Výrobnú dokumentáciu, viď kap. 1. Podrobnejší popis tejto dokumentácie je v štandarde KPI [1].

 

2/ Dokumenty pre realizáciu fyzickej časti systému

Dokumentácia obsahuje konštrukčnú a výrobnú časť používateľskej dokumentácie.Dokumentácia je určená pre tvorcov fyzických komponentov systému, ktorí majú byť tiež schopní realizovať v nich ďalšie úpravy, odstraňovať chyby a pod. Musí byť zostavená prísne hierarchicky na základe rekapitulačných listov. Jej zložitosť je daná stupňom modularity produktu a počtom rôznych komponentov na jednotlivých úrovniach. Zahŕňa v sebe aj dokumenty programov, ktoré sa implementujú v programovateľných súčiastkach, viď kap 1.

 

2.3      Dokumenty pre používanie integrovaného produktu

1/ Dokumenty pre používanie programovej časti integrovaného produktu

Dokumentácia je reprezentovaná Používateľskou príručkou. Táto je určená používateľom integrovaného technického aj programového produktu, ktorí nemajú k dispozícii dokumenty pre realizáciu programovej časti integrovaného produktu. Podrobnejší popis tejto dokumentácie je v štandarde KPI [1]. K Používateľskej príručke prislúchajú aj inštalačné média, na ktorých v reálnej praxi sú len binárne tvary programov. Pri školských úlohách sú tu tiež texty ostatných dokumentácii podľa charakteru úlohy.

 

2/ Dokumenty pre realizáciu fyzickej časti systému

Dokument predstavuje Návod na použitie fyzickej časti inegrovaného produktu, viď kap. 1.

 

3       Pokyny na popis médií

Média (disketa(y), resp. CD disky) ako prílohy musia obsahovať textové dokumenty vo forme príslušných súborov vrátane obrázkov a ďalších produktov počítačového spracovania (zdrojové texty, spustiteľné programy, výkresy a ostatné dokumenty.). Štítok média musí obsahovať:

názov katedry (pracoviska),

charakter produktu (Semestrálny projekt, Diplomová práca, názov predmetu a pod.),

prípadne ďalší upresňujúci názov média.

meno autora,

meno vyučujúceho(ich), resp. meno vedúceho a konzultanta-ov pri DP,

dátum odovzdania produktu,

označenie čísla média  v tvare <poradové číslo>/<celkový počet> (napr.: 1/1 pri jednom médiu, pri dvoch prvé bude označené 1/2, druhé 2/2 a pod.),

prípadný krátky popis prístupu na médium (heslo, spôsob rozbalenia, druh použitého programového prostredia a pod.).

Média musia byť umiestnené v sprievodnej správe tak, aby nebolo možné ich samovoľné vypadnutie, napr. v prilepenej obálke k hlavnému textovému dokumentu.

 

Súvisiace štandardy KPI:

 

[1] Dokumentácia pre programové prostriedky - 12

 

Zostavili:

Doc. Ing. Milan Šujanský, CSc.                      Ing. Stanislav Šuba

 

 

Košice, 6.3.2000