Obsahové požadavky
  • Užitečné rady pro psaní technického textu najdete například v přednášce doc. Šáry v předmětu NRP
  • Snažte se o maximální věcnost a stručnost. Jde o technický text, proto se vyhněte vágním formulacím, subjektivním dojmům a žoviálnímu slohu např.: „snímače ožily“, „tak jsme se s tím smířili“, „bezvadně funguje“, „naštěstí“, „sázeli jsme“, „těžko snáší“, „metoda oplývá jednoduchostí“ atd.
  • Pokuste se vyvarovat gramatických chyb a také zjevných logických nesmyslů „mosazné závaží z mosazi“, „nejoptimálnější“ (optimální je již samo o sobě nejlepší).
  • Když něco hodnotíte a srovnáte, tak popište kritéria, která jste brali v úvahu, aby někdo jiný mohl toto srovnání objektivně zopakovat. Rozhodně nestačí prohlásit třeba „odezva byla efektivní“.
  • Závěr není jen formalita, ale má stručně zhodnotit celou prací. Měl by shrnout, čemu se práce věnovala a jaké byly její výsledky, jaké jsou jejich omezení, co zbývá dokončit, poskytnout návrhy na budoucí rozšíření. Určitě tam nepatří věty typu: „Výsledky odpovídají mým představám“, „chová se dle očekávání“, „můj model slouží pro svůj účel dobře“, “I firmly believe“.
  • Pracujte s fyzikálními jednotkami. Nepoužívejte všelijak normované veličiny, např. napětí není bezrozměrná veličina v rozsahu 0 až 1, úhel se krom opodstatněných výjimek neměří počtem pulzů inkrementálního snímače…
  • Konzistence - pokud jednou zavedete nějaké označení, tak jej dodržujte. To platí zvláště pro fyzikální veličiny, ale i pro pojmenování součástí a formátování.
  • Důsledně uvádějte zdroje převzatých částí, ať už jsou to obrázky či části textu

Formální požadavky

Typografie

  • U symbolů důsledně rozlišujte, zda mají být vysázené obyčejným řezem, nebo kurzívou. Jednoduché pravidlo zní: To co může nabývat různých hodnot se sazí kurzívou (proměnné, fyzikální veličiny, ale i nepřesné konstanty jako elementární náboj, Planckova konstanta…). Vše ostatní se sází obyčejným řezem = jednotky, operátory, konstanty jako e, i, j, pi,… To platí i pro horní a dolní indexy, pokud neoznačují proměnnou.
  • Výše uvedené není jen zbytečná formalita, ale má dobrý důvod v rozlišení stejných symbolů v různých významech – m metr/hmotnost, d délka/diferenciální operátor, i imaginární jednotka/proud…
  • Proměnné a fyzikální veličiny označujte jedním písmenem, zamezíte tak možné záměně víceznakového označení se součinem. Používejte patkové písmo (tedy ne sans-serif), jinak není možné rozlišit např. I a I (velké i, a malé l).
  • Jednotky se od čísla oddělují poloviční nezalomitelnou mezerou (v LaTeXu \,). Ideálně by se také měly symboly u složených jednotek oddělovat poloviční mezerou (např. kW h), aby nedocházelo k záměnám s předponami pro násobnost (ms^-2, může být milisekunda na mínus druhou, nebo metr za sekundu na druhou)
  • Jako desetinný oddělovač se používá čárka (v českých textech), před kterou není mezera (v LeTeXu se toho dá docílit třeba {,}), nebo tečka (v anglických textech). Trojice cifer se mohou oddělovat poloviční mezerou, ale nepoužívejte k tomu účelu tečky a čárky mohlo by to být matoucí.
  • Používejte správné znaky. x ani * není násobení, - není mínus,

Rovnice

  • Rovnice musí být očíslované, aby bylo možné je z textu odkazovat a aby se na ně mohl posléze odkazovat čtenář.
  • Všechny symboly použité v rovnici by pod ní měly být definované, pokud se tak nestalo již dříve v dokumentu.
  • Rovnice jsou částí textu a mají být tedy oddělené interpunkcí – obvykle je za nimi čárka, nebo tečka.

Obrázky a grafy

  • Musí být dobře čitelné, to znamená vhodnou velikost fontu (ideálně blízkou okolnímu textu) a pokud možno vektorový formát. Pokud nejde použít vektorový formát (fotky, výstupy numerických simulací, apod.) tak je třeba zajistit dostatečné rozlišení (pro tisk typicky 300 dpi).
  • Pro lepší viditelnost je často výhodné kreslit grafy tlustou čárou (vlastnost LineWidth) a zvětšit značky (MarkerSize).
  • Grafy musí být správně popsány. Mezi samozřejmosti patří označení veličin a jednotek na osách, měřítko na osách a legenda pro více průběhů.
  • Obrázky musí být číslované a každý obrázek by měl být zmíněn a odkázán z textu (např.: ...blokové schéma je na obr. 5).
  • Obrázek musí mít výstižný titulek, tedy nikoli popisky typu obrázek, schéma apod.
  • U delších textů (knížky, závěrečné práce) se obrázky typicky umísťují k hornímu nebo spodnímu okraji, aby nepřerušovaly tok textu.

Užitečné tipy a odkazy pro Latex

Kreslení vazbeních grafů (pro domácí úkoly, semestrální práce)

Pro vytvoření (nákresu) vazebních grafů můžete samozřejmě využít libovolný grafický editor. Opět je ale vhodné využít takový editor, který podporuje vektorovou grafiku. Využít lze například:

Naposledy změněno: pondělí, 21. září 2020, 13.24