6.1 Textové dokumenty

Textové dokumenty jsou technické dokumenty ve kterých těžiště předávaných informací spočívá v plynulých textech (textových řetězcích ) textové informace v technickém dokumentu mohou být doplněny o další informace umísťované: - v textu dokumentu - jako přílohy textového dokumentu - tabulky - matematické vztahy, rovnice, výpočty - obrázky - diagramy (grafy) - výkresy - schémata - plány

Presentation of scientific and technical reports Pravidla platná pro technické textové dokumenty jsou stanovena mezinárodní normou ISO 5966 Documentation – Presentation of scientific and technical reports ČSN ISO 5966 Dokumentace. Formální úprava vědeckých a technických zpráv.

Technická zpráva má podle ČSN ISO 5966 tyto části: rozsáhlejší text.dokument zpracovávaný obvykle k určité události na př,: ukončení etapy výzkumu, ukončení zkoušek prototypu Její náležitosti by měly splňovat všechny rozsáhlejší technické dokumenty tedy i např.: Ročníková práce, Diplomová práce, Bakalářská práce Technická zpráva má podle ČSN ISO 5966 tyto části: úvodní část hlavní textová část závěrečná část dodatky, přílohy

přední deska a hřbet vazby…….podle charakteru dokumentu úvodní část: přední deska a hřbet vazby…….podle charakteru dokumentu titulní stránka……………………………….může nahradit desky Ukázka:

Mezinárodní standardní číslo Identifikační znak Identifikační znak Identifikační znak Mezinárodní standardní číslo MSČ Název instituce Sídlo instituce Název dokumentu Podnázev dokumentu Jméno PŘIJMENÍ (autora(ů)) Copyright Stupeň utajení

Poznámky k některým údajům titulního listu: identifikační označení dokumentu, tj. alfanumerické označení, které: identifikuje instituci (organizaci, podnik apod.), příslušnost dokumentu k určitému souboru dokumentů maximální povolený počet znaků je 32 mezinárodní standardní číslo seriálové publikace ISSN (Intemational Standard Serial Numbering), nebo knihy ISBN (Intemational Book Data Systém) jméno a příjmení autora způsoby zápisu: Křestní PŘIJMENÍ Křestní Příjmení datum vydání dokumentu. Formát data: ISO 2014 Příklady : leden 2000 15.září 2000 2000-10-20 2000-03-09

úvodní část (pokračování): abstrakt …………………………. informace o obsahu dokumentu, vyjadřuje cíle, metody, výsledky a závěry. Doporučený rozsah : 250 až 500 slov, má být srozumitelný i bez prostudování dokumentu. V textu se užívá celých vět, slovesa v činném rodu a ve třetí osobě. Abstrakt se umisťuje bezprostředně za titulní stránku- často na její rub. Je-li abstrakt umístěn na samostatné stránce, musí se před ním uvést úplná bibliografická identifikace podle mezinárodni normy ISO 30 klíčová slova……. se uvádějí za abstraktem. Mají být volena co nejvhodněji, aby vystihovali v dokumentu obsaženou problematiku. obsah……. uvádějí se názvy oddílů (kapitol) a pododdílů dokumentu a všech dodatků a příloh Každý údaj se doplní o příslušející čísla stránek. Součástí obsahu je i seznam obrázků a tabulek.

předmluva……není povinnou součástí dokumentu úvodní část (pokračování): seznam použitých zkratek (termínů)……Seznam (slovník, výklad) značek, zkratek a termínů v dokumentu použitých se umisťuje za obsahem. Odděleně se uvede: seznam značek veličin a jejich jednotek, seznam a význam zkratek, případně výklad termínů. Uvedení významu zkratky v tomto seznamu nezbavuje autora povinnosti výkladu v textu, kdykoliv se poprvé zkratky použije. předmluva……není povinnou součástí dokumentu V předmluvě se uvádí historické nebo jiné okolnosti, které vedly k napsání práce, vztahy dokumentu k jiným pracím apod. Předmluva se uvádí na závěr úvodní části

Hlavní textová část dokumentu úvod…….. uvádí se cíl práce, Obsahuje úvod…….. uvádí se cíl práce, její účel a smysl, případně volený metodický přístup jádro dokumentu ….. obsahuje text, obrazový materiál a tabulky . Jádro dokumentu se dělí na oddíly pododdíly články Další (hlubší) členění se nedoporučuje Číslování má odpovídat mezinárodní normě ISO 2145, například: obecně: příklad 1: příklad 2: 2. oddíl: 2 METODY MĚŘENÍ 2 METODY MĚŘENÍ 1. pododdíl 2. oddílu: 2.1 Tepelné veličiny 2.1 Tepelné veličiny 2. pododdíl 2. oddílu: 2.2 Elektrické veličiny 2.2 Elektrické veličiny 1. článek 2. pododdílu: 2.2.1 Napětí 2.2.1 Napětí 2. článek 2. pododdílu: 2.2.2 Impedance 2.2.2 Impedance

Doporučené uspořádání jádra dokumentu: Jádro dokumentu (zpráva) se člení do oddílů, pododdílů a článků podle logické stavby, tj. například na : oddíl zabývající se teorií, oddíl zabývající se použitými metodami, oddíl popisující průběh měření a naměřené hodnoty (výsledky) oddíl obsahující diskusi výsledků. Poznámky: Dokument je určen odborníkům s určitou úrovni odborných znalostí, proto není třeba příliš rozvádět popisy teorie a metod; postačí logicky srovnat jednotlivé dílčí kroky práce 2. Matematické důkazy, podrobnosti experimentů, nepodstatné ilustrace apod. je lépe uvést v dodatcích (přílohách)a v potřebném místě na tyto dodatky učinit odkaz.

Číslo odkazu v seznamu citované literatury Odkazy na publikace V textu dokumentu se umisťují odkazy na použitou resp. citovanou literaturu a prameny (odborné publikace, technické normy, atd). Odkaz může být proveden různými způsoby: 1.„. . . tyto hodnoty dosahují minimálně dvojnásobku původních [23]. Číslo odkazu v seznamu citované literatury 2.„... tyto hodnoty jsou podle Nováka (1991, s. 255) minimální.“ 3. „ tyto hodnoty jsou považovány [Novák, 1991, s. 255] za minimální .” Pro technické zprávy je doporučen způsob 1.

Hlavní textová část dokumentu (pokračování): závěry a doporučení …. - celkové zhodnocení výsledků práce a shrnutí kvantitativních údajů, - podrobnosti se neuvádějí. - doporučení se týkají možných dalších postupů poděkování…… uvádí se bez číslování oddílu doporučuje se poděkování umístit na samostatnou stránku na závěr textu jádra zprávy . Poděkovat se má za výraznou pomoc při zpracování zprávy, za poskytnutí přístupu na různá měřící zařízení, za pomoc kolegů, za poskytnutí práva na zveřejnění částí práce jiného autora apod.

Hlavní textová část dokumentu (pokračování): seznam citované literatury…. Umísťuje se na zvláštní stránku (stránky) na závěr hlavní textové části dokumentu Představuje číslovaný seznam všech citovaných informačních zdrojů použitých ve zprávě (dokumentu). Číslování má začínat číslicí 1. Číslice se uvádějí před vlastní citaci Způsob psaní citací se řídí normou ISO 690. Obecný příklad: [číslo] PŘÍJMENÍ, Jméno: Název díla. Údaje o vydání.

Hlavní textová část dokumentu (pokračování): Konkrétní příklady: Citace z knižního díla: 3 Doležal, V.: Plastické hmoty. Praha 1977, SNTL: s.60 – 61. Citace časopiseckého článku: 3 Drastík, F.: Vývoj způsobů předepisování jakosti povrchu na výkresech. Magazín ČSNI 5/1998: s.190 – 195. Citace statě ze sborníku: 3 Drastík, F. – Poláček, D.: International Standards of Accuracy of Machine Products and their Harnonization with CSN. Relations between Tolerance of Size and Geometry. In: Harmonizace českých technických norem pro strojírenství. Sborník referátů doprovodného programu mezinárodního strojírenského veletrhu. Praha 1996, ČSTVTS: s.20 – 22.

Hlavní textová část dokumentu (pokračování): Poznámky: V citacích periodik se mají uvádět jejich celé názvy. Lze citovat i jiné informace než tištěné. V citaci osobních informací se uvede příjmení a jméno osoby, která informaci sdělila, adresa jejího pracoviště a datum sdělení. Při citaci jiných než publikovaných informací se uvedou údaje, které informaci specifikují ( číslo jednací, číslo archivní položky, osobní archiv apod.)

se zařazuji bezprostředně za první zmínku o nich v textu Obrázky a ilustrace se zařazuji bezprostředně za první zmínku o nich v textu (případně okamžitě, jakmile lze obrázek či ilustraci vložit). obrázky a ilustrace, které nelze umístit na stránku v textu zprávy ( mapy, výkresy velkých formátů apod.) se umísťují v dodatcích jako přílohy a v potřebných místech se na ně udělá odkaz: Příklad: …….Umístění komparátoru (Příloha A) je takové, že……. se číslují : a) průběžně v celém dokumentu (přednostně) Příklad 1: Obrázek 6 Přiklad 2: Obr. 6 Diagram závislosti teplota - napětí nebo b) v každém oddílu zvlášť Příklad pro obrázek 6 v oddílu 2: Obr. 2-6 Uložení desky

1. jejichž formát odpovídá formátu listů zprávy se umísťují: Tabulky 1. jejichž formát odpovídá formátu listů zprávy se umísťují: pokud je to možné bezprostředně za prvním odkazem na tabulku nebo na nejbližším dalším vhodném místě. 2. rozsáhlé doplňující tabulky mohou být umístěny v dodatcích. 3.Číslování tabulek má být shodné s číslováním obrázků tj. průběžné v celém dokumentu nebo podle oddílů (např. tabulky v oddílu 3 jsou číslovány Tabulka 3 – x, kde x je pořadové číslo tabulky v oddílu). 4.číslo a název tabulky se umisťují nad tabulku vystředěně, Příklad: Tabulka 11 Naměřené hodnoty Hodnoty v milimetrech Tělo tabulky

Vzorce a rovnice obecně Jedná se o vzorce matematické, fyzikální i chemické vztahy mezi fyzikálními veličinami se vyjadřují podle . mezinárodní normy ISO 31 , část 0, používají-li se vztahy mezi číselnými hodnotami, musí se uvést odpovídající jednotky. Rovnice Rovnice se píší od pravého okraje stránky na samostatný řádek a oddělují se větší mezerou mezi řádky . Každá rovnice se označí pořadovým číslem v oblých závorkách- například: P = U . I (1) Pro lepší identifikaci čísla rovnice se doporučuje před číslo v oblých závorkách uvést zkratku eq. (z angl. equation), P = U . I (eq. 1)

Poznámky: 1. Nevejde-li se rovnice na jednu řádku, ukončí se řádka v místě za znaménkem (+, - , = ), 2. Znaménko se na další řádce před pokračováním rovnice opakuje. 3. Nedoporučuje se dělit rovnice v místě, kde jsou výrazy v závorkách nebo pod odmocninou apod.

Veličiny, jednotky a jejich značky Názvy a značky veličin jsou uvedeny v ISO 31. 2. Značky fyzikál­ních veličin se píší kurzívou (italic) vždy, kdy to je možné (například nelze uplatnit při psaní dokumentu mechanickým psacím strojem). 3. Názvy a značky veličin užité v dokumentu se uvádějí v seznamu značek, jednotek, zkratek a termínů. V technických dokumentech se používá jednotek a jejich násobků ze soustavy SI (viz normy ISO 31 a ISO 1000). 5. Jednotky použité v textu bez udání číselné hodnoty se vypisují slovy, například: „Naměřené hodnoty jsou udávány v milimetrech“

Závěrečná část Závěrečnou část textového dokumentu tvoří: analytický list rozdělovník s údaji o dostupnosti zadní deska Analytický list Slouží pro zpracování informací o dokumentu v automatizovaných rešeršních systémech. Obsahuje veškeré základní informace o dokumentu jako jsou: vydávající instituce, název, autor, datum vydání, čísla souvisejících projektů, abstrakt, údaje ISSN (ISBN), klíčová slova, klasifikační systém a třída apod. Doporučuje se ho provést i ve více světových jazycích. Rozdělovník s údaji o dostupnosti je seznam příjemců dokumentu označovaný jako DIL (Document Issuing List). Zadní deska. obsahuje údaj o uložení originálu (prvního výtisku) dokumentu a údaje o tiskárně nebo organizaci, která technicky zajistila realizaci dokumentu.