Technická dokumentace Ing. Lukáš Procházka Téma: hlavní část dokumentu, obrázky, tabulky a grafy 1) Obsah hlavní části dokumentu 2) Obrázky, tabulky a grafy 3) Vzorce a rovnice
Hlavní část dokumentu Hlavní část dokumentu je řazena v následujícím pořadí: dokument
poděkování úvod jádro dokumentu
zpráva + obrázky, grafy a tabulky závěr seznam použité literatury
Poděkování - v poděkování se děkuje kolegům, spolupracovníkům a konzultantům za jejich pomoc při zpracování dané problematiky - dá se děkuje rodině za toleranci a podporu při řešení problematiky
Úvod - název kapitoly ÚVOD se nečísluje
zpravidla je to kapitola č. 0 ÚVOD
obsahuje
neobsahuje
cíl práce
podrobnou teorii
Střední průmyslová škola na Proseku
Úvod:
účel práce
použité metody
smysl práce
výsledky
metodický přístup
neopakuje závěry doporučení
Cílem ročníkové práce je analyzovat stávající síťovou infrastrukturu, která je tvořena výhradně metalickými kabely a aktivními prvky v CAT 5 a navrhnout možné varianty inovace stávající síťové infrastruktury, tak aby …
neopakuje abstrakt
?
Co obsahuje hlavní část textových dokumentů?
ukázka úvodu
Jádro dokumentu - jádro dokumentu obsahuje vlastní technickou zprávu, obrázky, grafy a tabulky - jádro dokumentu se dělí na:
oddíl 1
jádro dokumentu
oddíl 2
pododdíl 1
1. článek pododdílu
pododdíl 2
2. článek pododdílu …
pododdíl 3 …
n. článek pododdílu
pododdíl n
1. článek pododdílu
oddíl 3
…
oddíl n
2 Počítačové sítě 2.1 Topologie 2.1.1 Kruh 2.1.2 Hvězda
2.2 Vrstvy ISO/OSI modelu 2.2.1 Aplikační vrstva 2.2.2 Fyzická vrstva
2. článek pododdílu … n. článek pododdílu
…
3 Průmyslové sítě 3.1 CAN BUS
?
Jaké označení by měla kapitola č. 1? odpověď:
Sítě (Obecně, pojem síť, …)
3.2 PROFI BUS příklad číslování oddílů
rozdělení oddílů v dokumentu
jádro dokumentu
- existuje doporučené rozdělení jádra dokumentu na oddíly dle logického uspořádání oddíl
obsah oddílu
oddíl(y) popisující teorii
V této části autor popíše teorii. Např. u práce zaměřené na výkon počítače, zde autor popíše počítač, respektive komponenty počítače mající vliv na výkon (CPU, RAM, VGA, …).
oddíl(y) popisující použité metody
V této části autor popíše použité metody k řešení dané problematiky. V tomto případě zde autor popisuje testovací programy, které je možné k měření použít (PCMark, PC Wizard, 3DMark, …) a možnosti těchto programů (co testují – VGA, CPU, HDD, …)
oddíl(y) popisující průběh měření a naměřené hodnoty
V této části autor popíše podmínky měření (použitý testovací program(y), testované počítače a další skutečnosti mající vliv na průběh měření. Dále pak naměřené hodnoty (ideálně uspořádané v tabulce).
oddíl(y) obsahující výsledky a rozbor výsledků
V této části autor popíše výsledky a provede jejich vyhodnocení. Porovná výsledky počítačů pro konkrétní testovací program. Případně porovná dosažené výsledky počítačů v jednotlivých testovacích programech a vyhodnotí.
Obrázky a ilustrace - obrázky se umísťují bezprostředně za první odkaz na obrázek, kde je to možné. - obrázky se značí: Při použití topologie hvězda (Obr. 5) síť je Obrázek 5 – …
Obr. 5 – …
funkční i při poruše koncového zařízení na rozdíl od topologie kruh.
- číslování obrázků bez rozlišení kapitol - příklad: 5. obrázek v dokumentu Obr. 5 – typ hvězda Obr. 5 – topologie sítě Obr. 5 – topologie sítě – typ hvězda - číslování obrázků dle kapitol - příklad: 2. obrázek v 2. kapitole Obr. 2-2 – topologie sítě Obr. 2-2 – topologie sítě – typ hvězda
i
Obr. 5 – topologie sítě – typ hvězda
příklad správného označení obrázku
Ilustrace, které nelze umístit vzhledem k velikosti na stránku dokumentu (výkresy, mapy, plakáty, …) se umísťují do příloh. V textu pak MUSÍ být uveden odkaz na tuto přílohu.
Grafy - grafy (diagramy) se umísťují bezprostředně za první odkaz na graf, kde je to možné. - z popisu grafu musí být jednoznačně patrné co daný graf zobrazuje. - grafy se značí stejně jako obrázky: Obrázek 5 – …
0,8
Obr. 5 – …
0,7
- graf musí obsahovat:
0,6
popis os, vč. jednotek
z názvu grafu je patrné co daný graf zobrazuje (Obr. 3 – VA char…) vyznačené naměřené body vhodně zvolený rozsah os
Napětí U [V] Napě
popis obsahu grafu (legenda)
0,5
0,4
0,3
0,2
0,1
0 0
20
40
60
80
100
120
140
proud I [A]
rozteč stupnice je stejně velká (výjimku tvoří logaritmická stup.)
Si dioda
Schottky dioda
Obr. 3 - VA charakteristika křemíkové a Schottkyho diody
graf obsahující všechny potřebné náležitosti
Vzorce a rovnice - vzorce a rovnice se umísťují průběžně, na samostatném řádku. - rovnice a vzorce se značí několika možnými způsoby: značení rovnic (3)
nedoporučuje se
(eq. 3)
z angl. equation
(rov. 3)
z čes. rovnice
- pro lepší identifikaci rovnice se označení pouhým číslem nedoporučuje Výkon je definován jako množství práce za jednotku času. V případě elektrického výkonu se jedná o elektrickou práci. Ve stejnosměrných obvodech jsou napětí i proud konstantní (eq. 2).
P = U .I
Průměrná rychlost nepopisuje rychlost pohybu tělesa v daném okamžiku, nýbrž říká jak velkou dráhu urazí těleso za jednotku času (rov. 2).
v=
(eq. 2)
označení rovnice – eq. xx
s t
(rov. 2)
označení rovnice – rov. xx
- pokud jsou vzorce číslovány podle kapitol, číslujeme je shodně jako obrázky značení rovnic dle kapitol (3-3)
nedoporučuje se
(eq. 3-2)
z angl. equation
(rov. 3-2)
z čes. rovnice
Formální úprava vzorců a rovnic - psaní číslic, čísel a matematických znaků se řídí normou ISO 31 - dle ISO 31 pro oddělení desetinných míst používáme čárky, v některých počítačových programech je možné užít pouze tečky - tečky ani čárky se nikdy neužívají pro oddělení řádů (tisíce, milióny, …) 2 110 152,25
2110152,25
2.110.152,25
0,667
0.667 (PC)
- nevejde-li se rovnice na jeden řádek, je možné ji rozdělit v místě za znaménkem +, -, =, které se opakuje na další řádce 3 3 2.R.I 2 + .R.I 2 R. 2 + .I 2 2.R.I 2 + R.I 1 2 2 Rcelk = = = = 3 3 I1 + I 2 .I 2 + I 2 + 1.I 2 2 2 3 7 2+ (rov. 2) 2 .R = 2 .R = 7 . 2 .R = 7 .R = 3 5 2 5 5 1+ 2 2
výpočty na více řádcích – rozděleno =
?
3 c a 3 c.a a 3 b 2 x = a . + 2 + c.(a − b ) − 2a − . = + + b b2 b ab 2 c 3b 3 2 2 3 + a .c.( a − b) − 2a − = ... (rov. 5) 2c 2
výpočty na více řádcích – rozděleno +
Jakým způsobem se označují obrázky, diagramy, rovnice a tabulky?
Tabulky - tabulky se umísťují bezprostředně za první odkaz na tabulku, kde je to možné. - rozsáhlé tabulky (např. naměřených hodnot) se umísťují formou grafu do dokumentu a formou tabulky do příloh - tabulky se označují obdobně jako obrázky:
Tabulka 2 – …
Tab. 2 – …
Procesor
Frekvence
Paměť
Tepel. výkon
Procesor
Počet jader
Frekvence [MHz]
Paměť L3 [MB]
Tepelný výkon [W]
č. 1
3,06
4
73
2
3,06
4
73
č. 2
3,33
4
87
Intel Core i3-540
2
3,33
4
87
č. 3
2,40
8
82
Intel Core i5-661
č. 4
2,93
8
95
Intel Core i5-750s
4
2,40
8
82
Intel Core i7-875K
4
2,93
8
95
Tab. 1 – Parametry testovaných procesorů
chybí typ procesoru
Tab. 2 – Parametry testovaných procesorů
chybí jednotky – MHz, MB, W
tabulka obsahuje jednotky i typ procesoru
chybí označení typu paměti – L3
jednotky – uvedeny v hranatých závorkách
nesprávně označená tabulka
správně označená tabulka
