Technická dokumentace 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í atd. autor ISBN, ISSN klíčová slova datum přijetí 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ý - stovky a tisíce listů - formát je příliš velký - nezbytná část - 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 dokument dodatky oddělovací stránka
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 označení číselné Dodatek A nebo Příloha A 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) 5. rovnice v pořadí v dodatku B (č. 2) Tabulka B.2 (rov. B.5) Tabulka 2.2 (rov. 2.5)? Co jsou to dodatky, co obsahují a jakým způsobem se označují objekty, které dodatky dodatcích?
Střední průmyslová škola na Proseku Textové dodatky příklad A Pro text, který chcete zobrazit jako titulek stránky ve vyhledávačích (podtržený odkaz) použijte tag <title>. Tag <title> je párovým tagem, takže musí být ukončen jako všechny párové tagy </title>. Obr. 11 - tag <title> 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: 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 Příklad 2: Převeďte číslo 101001100101011 2 do desítkové soustavy. Výsledek viz. (eq. 6) 10100101001100101011 2 = XX 10 (eq. 6) Úplné řešení příkladu č. 2 viz. Dodatek B. Dáno: 10100101001100101011 2 Řešení: 10100101001100101011 = 1x2 19 + 0x2 18 + 1x2 17 + + 0x2 16 + 0x2 15 + 1x2 14 + 0x2 13 + 1x2 12 + 0x2 11 + + 0x2 10 x 1x2 9 + 1x2 8 + 0x2 7 + 0x2 6 + 1x2 5 + 0x2 4 + + 1x2 3 + 0x2 2 + 1x2 1 + 1x2 0 = 1x524288 + + 0x262144 + 1x131072 + 0x65536 + 0x32768 + dokument, téma: rovnice - 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ů + 1x16384 + 0x8192 + 1x4096 + 0x2048 + 0x1024 + + 1x512 + 1x256 + 0x128 + 0x64 + 1x32 + 0x16 + + 1x8 + 0x4 + 1x2 + 1x1 = 676651 10-1 - dodatek úplný výpočet
Grafické dodatky příklad A Střední průmyslová škola na Proseku Dodatek A SPŠ na Proseku 2010 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
Grafické dodatky příklad B Střední průmyslová škola na Proseku 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ů dodatek výkresy (vrchní: form mát A1, spodní: formát A3) formát dokumentu A4 formát dokumentu A4