Elektronická technická dokumentace 17, 18. hodina
Bc. Lukáš Procházka
Téma: závěrečná část dokumentu, dodatky a manuály 1) Závěrečná část dokumentu 2) Dodatky 3) Manuály a návody – obsah dokumentu
Závěrečná část dokumentu Závěrečná část dokumentu je řazena v následujícím pořadí: dokument
analytický list rozdělovník s údaji o dostupnosti dodatky – součást dokumentu zadní deska dodatky – samostatný dokument
i
Pokud mají všechny dodatky pouze velikost formátu A4 (dokumentu) mohou byt součástí dokumentu, pokud mají dodatky jiný formát (např. schémata, výkresy, …) tvoří samostatný dokument (samostatné listy v deskách).
Analytický list - je důležitý z hlediska zpracování informací o dokumentu v automatizovaných rešeršních systémech - umísťuje se za poslední lichou stránku - doporučeno vytvořit jej ve více světových jazycích - obsahuje základní informace o dokumentu: obsah analytického listu název
instituce
abstrakt
datum vydání
autor
ISBN, ISSN
klíčová slova
datum přijetí
atd.
Rozdělovník s údaji o dostupnosti - seznam příjemců dokumentu – DIL (Document Issuing List) - umísťuje se na rubovou stránku zadní desky, nebo na samostatný list - součástí je informace o dostupnosti dokumentu (instituce, která dokument vydává) - případně obsahuje další specifické údaje o příjemcích (adresy, typ médií, …)
Rozdělovník s údaji o dostupnosti - obsahuje údaj o uložení originálu, případně o organizaci zajišťující realizaci dokumentu
Dodatky (Přílohy) - dodatky (přílohy) nejsou povinnou součástí každého dokumentu - obsahují ilustrace, tabulky, schémata, výkresy, podrobné matematické postupy … - do dodatků jsou tyto části zařazeny z důvodu: důvody zařazení do dodatků rozsahu
velikost formátu
stavby textu
- rozsah je příliš velký
- formát je příliš velký
- nezbytná část
- stovky a tisíce listů
- neodpovídá formátu dokumentu
- logická stavba textu
- např. mapy, výkresy, …
- velmi podrobné
- jsou samostatným dokumentem (nejčastěji v deskách), případně součástí dokumentu - pokud je formát shodný s dokumentem mohou být součástí dokumentu (1 vazba) - v tomto případě je vhodné vložit mezi dokument a dodatky barevný list - barevný list slouží ke snazší orientaci v dokumentu (dokument – dodatky)
desky dokumentu
oddělovací stránka dokument dodatky
Označování dodatků - dodatky se označují velkými písmeny abecedy vzestupně (A, B, C, D, …), případně je možné je značit číselně: označení velkými písmeny Dodatek A
nebo
Příloha A
označení číselné Dodatek 3
nebo
Příloha 3
- v celém dokumentu však musí být dodatky (přílohy) značeny stejným způsobem
Označování objektů v dodatcích - objekty v dodatcích se rozumí obrázky, tabulky, grafy, … (viz. hodina 13, 14) - obrázky, tabulky , grafy, … se značí obdobně jako v jádru dokumentu - pro rozlišení se u objektů přidává označení dodatku, do kterého spadají - značení objektů v dodatcích: (např. v dodatku č. 2 nebo označeného písmenem B) 3. obrázek/graf v pořadí v dodatku B (č. 2)
Obrázek B.3 – …
Obrázek 2.3 – …
2. tabulka v pořadí v dodatku B (č. 2)
Tabulka B.2 – …
Tabulka 2.2 – …
5. rovnice v pořadí v dodatku B (č. 2)
(rov. B.5)
(rov. 2.5)
¨
?
Co jsou to dodatky, co obsahují a jakým způsobem se označují objekty, které dodatky dodatcích?
Textové dodatky– příklad A Střední průmyslová škola na Proseku
Pro text, který chcete zobrazit jako titulek stránky ve vyhledávačích (podtržený odkaz) použijte tag
. Tag je párovým tagem, takže musí být ukončen jako všechny párové tagy .
Obr. 11 - tag použitý v kódu stránky Sami tvůrci webových vyhledávačů přikládají tomuto tagu velikou důležitost, jelikož lidé se ve výsledcích vyhledávání orientují podle textu odkazů. … Vytvořený HTML kód (Příloha 1) je …
dokument, téma: tvorba webové stránky - celý HTML kód je uveden v dodatcích - v dodatcích kvůli rozsahu (např. 20 stran) - v jádru dokumentu, jsou jen části kódu - části kódu jsou uvedeny jako doplněk textu zdůvodnění umístění HTML kódu do dodatků
dodatek – tabulka parametrů
Textové dodatky– příklad B Střední průmyslová škola na Proseku
Dodatek B – řešení příkladu č. 2
3.2. Dvojková soustava:
Dáno: 101001010011001010112
Dvojkovou soustavou je soustava, která může nabývat pouze hodnot 0 a 1. Užívána je zejména ve výpočetní technice. Všechny výpočty …
Řešení: 10100101001100101011 = 1x219 + 0x218 + 1x217 +
… + 0x216 + 0x215 + 1x214 + 0x213 + 1x212 + 0x211 + Příklad 2: Převeďte číslo 1010011001010112 do desítkové soustavy. Výsledek viz. (eq. 6) 101001010011001010112 = XX10
(eq. 6)
+ 0x210 x 1x29 + 1x28 + 0x27 + 0x26 + 1x25 + 0x24 + + 1x23 + 0x22 + 1x21 + 1x20 = 1x524288 +
Úplné řešení příkladu č. 2 viz. Dodatek B. + 0x262144 + 1x131072 + 0x65536 + 0x32768 +
dokument, téma: rovnice - celý HTML kód je uveden v dodatcích
+ 1x16384 + 0x8192 + 1x4096 + 0x2048 + 0x1024 + + 1x512 + 1x256 + 0x128 + 0x64 + 1x32 + 0x16 +
- v dodatcích kvůli rozsahu (např. 20 stran) - v jádru dokumentu, jsou jen části kódu - části kódu jsou uvedeny jako doplněk textu zdůvodnění umístění HTML kódu do dodatků
+ 1x8 + 0x4 + 1x2 + 1x1 = 67665110
-1-
dodatek – úplný výpočet
Grafické dodatky– příklad A Střední průmyslová škola na Proseku
Dodatek A
SPŠ na Proseku
Navržený řídící program byl vytvořen v grafickém programovacím prostředí (Ladder diagram). Program (Dodatek A) umožňuje ovládání měřícího zařízení ve 3 režimech: automatickém, manuálním a servisním. Automatický režim je určen pro běžný provoz zařízení. Manuální režim je určen pro testování všech funkcí měřícího zařízení. Tento režim může být spuštěn až po dokončení celého cyklu v automatickém režimu. Servisní režim je určen pro manipulaci se zařízením v případě kolizí. …
dokument, téma: řízení zařízení - celý program je uveden v dodatcích - v dodatcích kvůli rozsahu (např. 50 stran) - v jádru dokumentu, jsou jen části programu - části jsou pak důležité pro pochopení textu zdůvodnění umístění programu do dodatků
dodatek – PLC program
2010
Navržená modernizace konzole frézky FNGJ 20 popsaná v tomto dokumentu je přípravou pro její fyzickou modernizaci. … Uspořádání pohybových mechanismů konzole frézky je zobrazeno v návrhovém výkrese, který je nedílnou součástí tohoto dokumentu (Příloha 1). … Podklady pro výrobu jednotlivých součástí jsou detailně popsány v kap. 5 – Realizace. … Výrobní výkres hřídelů osy X konzole (Příloha 1).
dokument, téma: rekonstrukce stroje - výkresy jsou standardně v dodatcích - formát výkresu je větší než dokument - jiný typ reprodukce než dokument - výkresy jsou součástí jedné přílohy zdůvodnění umístění do dodatků
formát dokumentu A4
Střední průmyslová škola na Proseku
dodatek – výkresy (vrchní: formát A1, spodní: formát A3)
Grafické dodatky– příklad B
formát dokumentu
A4
Manuály - manuál = uživatelská příručka, návod k použití obsah manuálů:
- povinnou součástí zařízení - ve více jazycích (EN, DE, …)
HARDWARE
SOFTWARE
obsah
obsah
bezpečnostní opatření příslušenství zařízení systémové požadavky
systémové požadavky
popis zařízení pokyny k instalaci
pokyny k instalaci
provozní pokyny
uživatelské rozhraní
odstranění problémů
odstranění problémů
technické parametry údržba a servis poznámky
poznámky
Zadání semestrální práce – manuál Zadání - vytvořte manuál (návod k použití) z oblasti informačních technologií - zobecněná témata: 1) instalace a základní konfigurace antivirového softwaru 2) instalace a základní konfigurace kodeků 3) instalace a základní ovládání programů pro prohlížení pdf souborů 4) instalace a základní nastavení multimediálních přehrávačů 5) instalace, popis a základní ovládání počítačové hry
Podmínky odevzdání - 10.12. volba tématu – výběr a specifikace (konkrétní SW) ze zadaných obecných témat - 30.12. odevzdání v elektronické podobě (*.pdf) na lukas.prochazka@sps-prosek.cz
Podmínky odevzdání - manuál bude obsahovat náležitosti uvedené v této prezentaci - manuál bude obsahovat titulní stránku, obsah, … (viz. předchozí hodiny) - minimální rozsah 10 stran A4