11, 12. hodina Elektronická technická dokumentace Bc. Lukáš Procházka Téma: obsah úvodní části, úvodní část 1) Úvodní části 2) Titulní stránka 3) Anotace (abstrakt a klíčová slova) 4) Obsahy a seznamy Úvodní část Úvodní část je řazena v následujícím pořadí: obal desky (přední deska + hřbet) dokument titulní stránka anotace obsah technické informace seznam použitých značek, veličin a jednotek seznam použitých zkratek předmluva
Obal - obal se skládá z přední desky, hřbetu a zadní desky - obal chrání dokument před poškozením - zadní deska není součástí úvodní části - přední deska musí obsahovat charakteristické informace o - desky úředních dokumentů standardně obsahují pouze charakteristické informace - desky komerčních dokumentů nemají strohý vzhled jako desky úředních dokumentů přední deska hřbet vazby desky úředního (závěrečná práce) strohý vzhled pouze charakteristické informace desky komerčního poutavý vzhled - snaha zaujmout - prodat
Přední deska a hřbet identifikační označení (ID znak) mezinárodní standardní číslo název a sídlo instituce - alfanumerické označení - identifikuje organizaci, firmu, - dále příslušnost k dalším dokumentům a samotný dokument - počet znaků včetně pomocných má být minimální, maximálně však 32 - značení se umísťuje do pravého horního rohu (doporučeno 3x) - seriálové publikace ISSN (International Standard Serial Numbering) - knižní publikace ISBN (International Standard Book Numbering) - pokud je označení ISSN a ISBN, musí být uvedeno na každém výtisku - umísťuje se pod ID znak do pravého horního rohu - případně je vhodné doplnit i o telefonní číslo, fax či e-mail - - úprava adresy se řídí doporučením příslušné národní pošty jméno a příjmení autora datum vydání další údaje - doporučený formát: Jan NOVÁK příjmení velkými písmeny - více autorů = abecedním pořadí, hlavní autor = jako první - formát data je dle ISO 2014 - formáty: a) leden 2010 b) 15. září 2010 c) 2010-03-20 - klasifikace z hlediska utajení, copyright, - informace mohou se umísťují na přední desce nebo titulní stránce hřbet vazby - doporučuje údaje (pokud to jde): příjmení autora, název a ID znak - u spodního okraje má být zachován pruh o délce min. 30 mm (archivace)
Možné uspořádání přední desky datum vydání (+ místo) další údaje (copyright) Název instituce Název Podnázev Jméno PŘÍJMENÍ autora(ů) číslo ISBN Autor Název dokument tu ID znak 30mm Laboratorní zpráva diagnostika síťových kabelů Jan Novák Tomáš Starý 15.10.2010 možný obsah předních desek + hřbetu přední desky SPŠ na Proseku
Titulní stránka identifikační označení mez. stand. číslo název a sídlo instituce název - ID znak viz. Přední deska a hřbet - dokument je svázán do více částí všechny části = stejný ID znak - ID znak je doporučeno uvést v záhlaví/zápatí každé stránky -číslo ISSN nebo ISBN viz. Přední deska a hřbet - uvádí se na titulní stránce nebo na rubu titulní stránky - viz. Přední deska a hřbet - úplný název i podnázev uvedený na titulní stránce musí být shodný s názvem a podnázvem uvedeným na předních deskách jméno a příjmení autora datum vydání datum priority autora - viz. Přední deska a hřbet - případně se uvádí i jejich pracoviště, není-li již uvedená instituce - viz. Přední deska a hřbet - při uvádění tohoto data musí předcházet slova: Rukopis dokončen - datum se uvádí v hranatých závorkách, nebo menším písmem - může být uvedeno i na rubu titulní stránky? Jaké jsou charakteristické údaje uváděné na předních deskách, hřbetu vazby a titulní stránce?
Možné uspořádání titulní stránky Název instituce číslo ISBN Název Podnázev Ročníková Práce Možnosti konfigurace switchů Hewlett Packard a Cisco Jméno PŘÍJMENÍ autora(ů) Jan Novák Tomáš Starý datum vydání (+ místo) datum priority možný obsah titulní stránky 20.5.2011 titulní stránka SPŠ na Proseku
Anotace - se skládá z abstraktu a klíčových slov - standardně se uvádí ve 2 jazycích (jazyk + cizí), např. CZ + EN Abstrakt - abstrakt = výtah, referát - informuje o obsahu : obsah abstraktu cíle práce metody výsledky závěry - doporučený rozsah abstraktu je cca ½ až 1 stránka A4 - v abstraktu se používají celé věty, obrázky a další grafické objekty jsou se nepoužívají - umísťuje se bezprostředně za titulní stránku: a) na rub b) na samostatný list - v případě samostatného listu je potřeba uvést úplné bibliografické údaje podle ISO 30: bibliografické údaje dle ISO 30 jméno a příjmení autora úplný název identifikační znak instituce datum vydání Klíčová slova - klíčová slova jsou uváděna za abstraktem - volí se tak, aby co nejvhodněji vystihovali obsah
Možné uspořádání Anotace samostatný list Záhlaví Bibliografické údaje jméno a příjmení autora název identifikační znak instituce datum vydání (vyhotovení) Anotace: Jméno autora Název Instituce Datum vydání Jan Novák Konfigurace switchů Cisco Catalyst 2950 2010/2011 Anotace Abstrakt cíle práce metody výsledky závěry Klíčová slova Abstrakt Klíčová slova Ročníková práce spočívá v možnostech konfigurace switchů Cisco Navrhované konfigurace byly testovány pomocí simulátoru Packet Tracer Vhodná varianta konfigurace byla vybrána na základě výsledků simulací Konfigurace swichů byla realizována pomocí webového rozhraní Cisco, Packet Tracer, konfigurace, počítačové sítě, topologie, RJ-45, switch, TCP/IP Zápatí - 5 - možné rozložení anotace příklad anotace práce na téma PC sítě
Seznamy - všechny seznamy se umísťují bezprostředně za Anotaci Seznamy Obsah Seznam značek veličin a jednotek Seznam a význam zkratek příp. Výklad termínů Obsah - obsah je povinnou součástí dokumentů (výjimkou jsou velmi krátké dokumenty) - obsah se umísťuje uje za anotaci na samostatnou stránku - do obsahu se uvádějí celé názvy kapitol i podkapitol - pokud se dokument skládá z více částí úplný obsah je v každé části - tyto seznamy se umísťují za obsahem Seznam značek, zkratek a termínů - každý z nich (pokud je k dispozici, tj. vždy pokud je v použitá jakákoliv zkratka či veličina) se umísťuje na samostatný list? Co obsahuje anotace, v kolika jazycích se uvádí a jakých?
Možné uspořádání seznamů Seznam značek veličin a jednotek: Seznam použitých zkratek: veličina značka jednotka hmotnost m g síla F N tlak p Pa délka l m rychlost v m.s -1 zrychlení a m.s -2 frekvence f Hz úhlová rychlost ω rad -1 AD BC CPU DIS DVD HTTP HTTP NP PC PS VGA WWW Active Directory Binary Code Central processing Unit Dokumentografické informační systémy Digital Versatile Disk HyperText Transfer Protocol HyperText Transfer Protocol Network Provider Personal Computer PostScript Video Graphics Array World Wide Web - 6 - - 7 - příklad seznamu veličin a jednotek příklad seznamu použitých zkratek
Předmluva - umísťuje se bezprostředně za seznamy před hlavní textovou část - předmluva není povinnou součástí - pokud je dokument vydán ve více svazcích, předmluva je obsažena pouze v první části - předmluva může obsahovat: Obsah předmluvy vztah k jiným dokumentům historické okolnosti vedoucí k napsání jiné okolnosti vedoucí k napsání - někdy může být předmluva umístěna přímo na rubové straně předních desek? Co obsahuje úvodní část, které z nich jsou nepovinné?