PSANÍ TEXTŮ A TECHNICKÝCH ZPRÁV Ing. Zdeněk FOLTA, Ph.D. Vysoká škola Báňská-Technická univerzita Ostrava, Fakulta strojní, Katedra částí a mechanismů strojů - 347, 708 33 OSTRAVA-Poruba, ul. 17. listopadu 15, tel. 069 699 3393, e-mail: Zdenek.Folta@vsb.cz THE TEXTS AND THE TECHNICAL REPORTS WRITING Annotation: The article describes the arrangement of the text for writing the technical texts for measurement, calculational and similar reports, articles and so on. 1. Úvod Při psaní technických zpráv, zvláště prací vypracovávaných studenty jsou texty často formátovány způsobem, který neodpovídá pravidlům pro jejich psaní. Je vhodné, aby se student seznámil se správným způsobem jejich psaní, aby pak nebyl zejména v praxi opravován svými podřízenými ale aby tomu bylo naopak. V následujících odstavcích je výběr těch nejdůležitějších zásad. Úplné informace je možno získat v literatuře, která je uvedena na konci článku. Kurzívou jsou ve článku vždy uvedeny příklady. V kapitole 2 není dodržen způsob formátování odstavců z důvodu přehlednosti textu. 2. Psaní textů Základní řádková rozteč pro psaní v textových editorech je jednoduché řádkování které má šířku 1/6 palce, tedy 4,23 mm (pro písmo 10 bodů). Tato rozteč a její násobky by měly být dodrženy při vytváření tiskopisů a předtisků (například pro kusovník) aby byla zajištěna možnost vypisování pomocí psacího stroje. Písemnosti s vyšším nárokem na přehlednost se řádkují 1,5 x nebo 2 x základní řádkování. Základní výška písma je 2,54 mm, tedy 1/10 palce (odtud označení velikosti písma 10 bodů). Dopisy a jiné úřední písemnosti se nemají psát písmem menším než 10 bodů. Doporučuje se používat písmo stojaté (kolmé); kurzívou (italika) se pouze zvýrazňují určité části textu. Odstavce se začínají od levé svislice, nebo se od ní odráží, zpravidla o 5 úhozů (pro písmo 10 bodů to je asi 7,5 mm). Při jednoduchém řádkování se mezi odstavci řádkuje dvakrát, při řádkování 1½ jednou nebo dvakrát, u řádkování 2 jedenkrát.
Číslování stránek se provádí arabskými číslicemi v záhlaví nebo v zápatí uprostřed nebo na vnějším či vnitřním okraji textového sloupce. Titulní list se nečísluje, ale započítává do počtu stránek. Interpunkční znaménka tečka, čárka, dvojtečka, středník, vykřičník, dvojtečka, otazník se připojují k předchozímu slovu, zkratce nebo číslu bez mezery. Za každé interpunkční znaménko patří mezera mimo následující výjimky: - odděluje-li tečka označení části textu (1.3.5) nebo v peněžních částkách (12.345,00 Kč); - za čárkou odděluje-li desetinné místo (2,45); - před a za spojovníkem (Frýdek-Místek, česko-polský); - před a za lomítkem (100 km/h, 3 4/5); - za dvojtečkou při psaní časových údajů (10:45); - následuje-li více znamének za sebou (... od Smetany ( Má vlast ), od Dvořáka...); - za znaménky + a pokud označuje hodnotu čísla (+5 ºC); - při psaní horních a dolních indexů (m 3, H 2 O, disketa 3,5 ); - při vyplňování rubrik tiskopisu, není-li dostatek místa. Tři tečky... mohou znamenat vynechaný text (1, 3... 7, 9) nebo pokračování výčtu (V naší ZOO je možno denně vidět hlavně savce (myši, tygry, slony...) a ptáky (sovy, holuby, pávy...).). Spojovník spojuje dvě části slova nebo dva výrazy bez mezer (Plzeň-sever, bude-li...). Pomlčka se odděluje z obou stran mezerami (Nabízíme s omezením i léky). Pomlčka může nahrazovat i slovo do nebo až do nebo proti (versus) (Zápas Sparta Slávia, Prodejna bude uzavřena 11. 18. června). (Není vhodné používat tvar Otevřeno od 8 16 hodin neboť tento zápis může být vysvětlen tak, že se prodejna otevírá někdy mezi osmou a šestnáctou hodinou. Správně je Otevřeno od 8 do 16 hodin nebo Otevřeno 8 16 hodin.) Závorky a uvozovky přiléhají k začátku a konci textu bez mezer, od ostatního textu se oddělí mezerami (Je to maskot družstva.). Je-li v uvozovkách či závorkách celá věta, dělá se koncová uvozovka či závorka před závěrečnou tečkou ( Dělej něco.). Zkratky se píšou podle Pravidel českého pravopisu: - tečka za zkratkou kterou tvoří začátek slova: p. (pan, pánové), popř., r. (rok), zvl. (zvláště); - bez tečky tvoří-li zkratku začátek a konec slova: fa (firma, faktura), fy, fu, pí (paní) ca, cca (circa); - s tečkami a mezerami uvnitř zkratek: a. s., t. r., v. r., Ústí n. Orl., č. j, č. p.; - některé zkratky bez mezer a teček uvnitř zkratky: tj., atp., atpod., čj, čp; - bez teček za zkratky z velkých počátečních písmen: ČR, AV ČR, ČSAD, OSN, VŠB-TU; - označení firem: a. s. Kormorán, v. o. s. Laguna, Krach, spol. s r. o.,
Zkratky titulů se píšou: - s tečkou před jménem: MUDr. (doktor všeobecného lékařství), MVDr. (veterinární doktor), JUDr. (doktor práv) RNDr. (doktor přírodních věd), PaedDr. (doktor pedagogiky), PhDr. (doktor filozofie), PharmDr. (doktor farmacie), PhMr. (doktor farmacie), ThDr. (doktor teologie), Dr.h.c. (čestný doktor), Dr. (doktor - v oblasti technických věd), Ing. (inženýr), pplk. (podplukovník), mjr. (major), prof. (profesor), doc. (docent); - za čárkou za jménem s tečkou: CSc. (kandidát věd) DrSc. (doktor věd), Ph.D.(doktror v oblasti technických věd); Příklady: MUDr. Jiří Smrt, DrSc., prof. Ing. Petr Pavel, Ph.D., plk. Ing. Ivo Střela, CSc. Značky jednoduchých měřících jednotek: 10 mm, +6 V, 8,77 kg, 7 x 5 m, 10:00 h, 12 min. Značky složených měřících jednotek: -15 ºC, 300 kw, 20 VA, 20 V.A, 20 V A, 5 Nm, 12 kwh; Přídavné jméno číslicí: 6V baterie, 6voltová baterie, 3 x větší, 3krát větší, 3procentní sleva. Značky měn v sestavách: Kč 12,--; CZK 12,--; Ft 120,15; USD 12.000,-. Značku měn v textu: sleva Kč 200,--; sleva Kč 200; sleva 200 Kč. Matematické značky se oddělují mezerami: 10 + 20 = 30; (a + b) c = z. Při přechodu výrazu na další řádek se značka na konci opakuje na dalším řádku: (a + b) c + a 2 + d = = z. Zlomky: 1/2; 3/4; 10 3/4 kg; 7 1/4 m; 8 11/12 ha; 2 ½ in.. Desetinná místa desetinných čísel se oddělují čárkou, jednotlivá čísla v případě potřeby středníkem. Čísla, která mají více než tři číslice vlevo či vpravo od desetinné čárky se mohou oddělovat mezerou, u peněžních částek je možno vložit tečku: 22,45; 34 456,55; 0,089 234; 33 234,123 456, 12.365,-- Kč, USD 12.130.000,50. Pozor na dokumenty pocházející z USA, kde se obvykle desetinné místo odděluje číslem a tři čísla vlevo a vpravo čárkou (USD 12,130,000.50). Tento formát někdy podporují i počítačové programy. Mezní úchylky, 5 ±1, 12 ±0,05, pokud jsou uvedeny měrné jednotky, píšou se s číslem rozměru do závorky: (44 ±0,1) mm, (-13 ±2) ºC. Měřítko se píše s dvojtečkou s oddělením mezerami. Označuje se slovem měřítko nebo jeho ekvivalentem v jazyku, ve kterém je dokumentace pořízena (Měřítko 5 : 1) nebo se toto slovo neuvádí (5 : 1). (Starý zápis M 5 : 1 se nepoužívá).
Exponenty a indexy se píšou bez mezer: (a + b) 2 ; 12 10-5, 300 m 2, H 2 SO 4,. Stejnítka se používají v sestavách při opakování stejného slova. Píšou se pod první písmeno stejněného slova a nesmějí se používat pro čísla: Kč 222,50 10 vagónů krmných brambor 12,00 15 stolních 123,50 5 Kalendářní data, pokud je měsíc uveden číslem, se píší sestupně, přičemž se čísla oddělují spojovníkem, měsíc a den se vyjadřuje vždy dvoumístně (1999-12-28, 99-03-03, 00-12- 02). Kalendářní data s měsícem uváděným slovně v textu (zvlášť důležité pro dokumenty, které se mohou stát součástí soudního řízení poznámka autora) se píší vzestupně (5. dubna 1998). Časové údaje se píší sestupně, dvoumístně a oddělují se dvojtečkami (10:30:15, 10 h 30 min 15 s, 03:15 h, v 10 hodin). Telefonní a faxová čísla se píší po dvojicích počínaje zprava, lichý počet číslic začíná trojčíslím (22 34 45 87, 123 34 67, 876 65). Spojení písmen s čísly, pokud je vytvářena značka či slovo, se dělá bez mezery (10násobek, 5krát, odd. IIb, formát A4, Alšova 12a). 3. Technická zpráva Technická zpráva obvykle tvoří doprovodný text konstrukčních projektů nebo je přímo výsledkem měřičské či výzkumné činnosti. Následující text je výňatkem z ČSN ISO 5966 (01 0173) Formální úprava vědeckých a technických zpráv v rozsahu pro běžné technické zprávy k výkresové dokumentaci či z měření. Pro rozsáhlejší či významnější zprávě je nutno uplatnit další části z uvedené normy. Údaje které pro konkrétně zpracovávanou zprávu nemají význam (u zprávy z měření stupeň utajení, číslo ISSN apod.) se vynechají. Zpráva by měla obsahovat následující části: 3.1 Úvodní část 3.1.1 Titulní stránka Je první lícová lichá stránka, první stránka zprávy, která by měla obsahovat v daném pořadí: - omezení distribuce nebo stupeň utajení (je-li požadováno, umisťuje se do levého horního, nebo dolního pravého rohu); - jméno a adresa odpovědné instituce, v případě potřeby i telefonní nebo faxové číslo či e-mailová adresa; - úplný název zprávy;
- jméno (jména) autora (autorů) se zvýrazněním příjmení (velká písmena, podtržení, křestní jméno kurzívou...) s uvedením pracoviště není-li totožné s odpovědnou institucí - datum.vydání (30. března 2001, březen 2001, 2001-03, 2001-03-30); 3.1.2 Referát (abstrakt) Je to stručný souhrn obsahu dokumentu, aby čtenář po jeho přečtení mohl rozhodnout, zda potřebují číst celý dokument. Vyjadřuje cíle, metody, výsledky a závěry se zvláštním důrazem na výsledky a závěry. 3.1.3 Obsah Je povinnou součástí zpráv s výjimkou velmi krátkých. Obsahuje názvy hlavních pododdílů zprávy a všech dodatků včetně čísel stran. Připojuje se i seznam obrázků a tabulek. 3.1.4 Slovník znaků, symbolů, jednotek, zkratek, akronymů a termínů Obsahuje seznam uvedených prvků které nemusejí být čtenáři srozumitelné. Existence těchto seznamů neopravňuje k k vynechání výkladu v textu, kde se uvedený prvek vyskytne poprvé. 3.2 Hlavní textová část 3.2.1 Úvod Úvod by měla obsahovat každá zpráva. Popisuje účel a cíle dané práce, vztah k jiným pracem a zhruba zachycuje metodický postup. Úvod není součástí hlavního textu a nečísluje se, nebo se mu přidělí číslo 0. 3.2.2 Jádro zprávy s hlavními ilustracemi a tabulkami Jádro by mělo být rozděleno do číslovaných pododdílů, které pokrývají takové položky jako je teorie, metody, výsledky a diskuse. Všechny ilustrace a tabulky nutné k pochopení jádra textu by měly být začleněny do jádra zprávy a to co nejdříve po prvním odkazu na ně. Ilustrace (obrázky, mapy, diagramy grafy ) se obvykle jednotně označují jako obrázek. Číslování se provádí podle následujícího příkladu: Obrázek 4 3 což je třetí obrázek v oddíle 4. Každá ilustrace musí mít popisný text, který se umisťuje na její spodní okraj. Tabulky se číslují jednotně označením Tabulka 3 a doplňují se výkladem tak, aby byla tabulka pochopena i bez čtení textu. Číslování se provádí obvykle tak, jak jsou číslovány kapitoly tohoto článku. 3.2.3 Závěry a doporučení Závěr by měl jasnou a přesnou prezentaci dedukcí pocházejících z celkového hodnocení práce. Lze zahrnout i kvantitativní údaje ale bez uvedení podrobností či argumentů (ty jsou v jádru zprávy). Oddíly se závěry a doporučeními nemusí mít vlastní čísla oddílů.
3.2.4 Soupis citací Je to soupis všech pramenů, na nichž zpráva závisí a na něž se autor z textu odvolává (tyto části jsou označeny číslem v hranaté závorce). Doplňková literatura, na kterou se přímo neodkazuje ale může být pro čtenáře zajímavá se uvádí v dodatcích v oddílu bibliografie. 3.3 Dodatky Jsou části zprávy které nebyly zahrnuty do jádra zprávy protože: - by mohly odvést pozornost od logického uspořádání; - nemohou být umístěny z důvodu rozsahu nebo způsobu reprodukce; - mohou být pominuty většinou čtenářů a jsou hodnotné pro specialisty. Zde patří zejména: - doplňkové ilustrace či příklady; - výjimečné materiály jako jsou mapy, originální fotografie, mikrofiše, rozsáhlé tabulky; - bibliografie, tedy literatura zajímavá pro čtenáře ale neodkazována přímo v textu; - popis vybavení, metod nebo počítačových programů; Dodatky se číslují souvislou řadou velkých písmen (Dodatek A, Dodatek B ) s přídavným číslováním jako u jádra programu (Dodatek A.1.3, Tabulka B.5 ). 4. Literatura: ČSN 01 6910, Úprava písemností psaných strojem nebo zpracovaných textovými editory, Český normalizační institut, 1997. ČSN ISO 5966 (01 0173), Formální úprava vědeckých a technických zpráv, Český normalizační institut, 1995. ČSN ISO 690 (01 0197), Bibliografické citace, Český normalizační institut, 1996.