Obsah a styl odborných prací
Obsah |
Co psát do dokumentace
- Co není v dokumentaci, jako byste nedělali.
Pokud jste měsíc řešili problémy s ovladači síťové karty, uveďte je.
- Nepopisujte ale dopodrobna všechny nepovedené cesty, které nevedly k cíli.
- Nejprve uveďte správné řešení. Vysvětlete problémy, které bylo třeba vyřešit a popište správné řešení.
- Pak zmiňte varianty, které se ukázaly jako nepoužitelné, aby se jimi čtenáři ani nezkoušeli pouštět, nebo věděli, že asi narazí.
- Neztrácejte čas obecně známými banalitami, které se najdou na 150 různých fórech.
- Pište to, co jste museli skutečně sami zjistit (vynechte věci, které jste museli zjistit, protože jste už zapomněli, že jste se to učili loni... ;)).
Pište stručně, jasně a přesně
- Používejte jednoduchý styl, vyhněte se stylistickým ozdobám. Snažte se omezit na strohá fakta, vynechte nepotřebné fráze.
Místo: Výborně, máme nainstalovánu ústřednu. Nyní se můžeme pustit do hrátek s klientem...
Pište: Ověříme funkčnost ústředny příkazem ... Dále je třeba nakonfigurovat klienta. Spustíme ...
- Preferujte jednoduché věty, složitá souvětí rozložte na více samostatných vět či kratších souvětí.
- Buďte přesní a co nejvíce konkrétní!!!
- Omezte použití ukazovacích zájmen. Každá věta by měla nést informaci sama o sobě.
Ne: ... zkoumali jsme vlastnosti systému Joomla. Využívají ho milióny webů... Raději: ... zkoumali jsme vlastnosti redakčního systému Joomla. RS Joomla využívají milióny webů...
Odborné termíny
- Dbejte na správné použití odborných termínů z oblasti, o které píšete.
Ne: Stačí jen stáhnout, rozbalit a spustit.
Ale: Pro instalaci webového serveru stačí stáhnout instalační balíček, rozbalit jej a spustit instalační program.
- Pokud existuje více termínů se stejným významem (synonyma), zvolte vždy jeden a používejte ho v celé práci.
- Při první použití termínu či v místě, kde termín objasňujeme, je možné zmínit i další ekvivalentní termíny (synonyma) pro upřesnění pro čtenáře, kteří by znaly pouze tyto ekvivalentní termíny.
Spisovný jazyk, forma
- Používejte spisovný jazyk, vyhýbejte se hovorovým termínům.
- Nepoužívejte trpný rod!
Nepište: Bude vyzkoušeno nastavení a bude zprovozněna i ústředna...
Napište: Ověříme nastavení, zprovozníme ústřednu a vyzkoušíme následující scénáře: ...
- Pište v množném čísle!
- Na odborné práci se vždy podílí více lidí. Minimálně vy a vedoucí práce, který vás (většinou) nasměroval k tématu, kterým se zabýváte, a který vás v průběhu projektu usměrňuje.
- Je to zvyk, naučte se ho a dodržujte ho! ;)
Nadpisy
- Při volbě nadpisů se snažte, aby co nejlépe postihovaly skutečný obsah kapitoly.
- Zároveň by ale nadpisy měly být krátké.
Ne: Vzhled stránky
Ale: Tvorba šablony vzhledu
Ne: Menu
Ale: Tvorba struktury menu
Nepište banality
- Neztrácejte čas popisováním zřejmých věcí! Snažte se vysvětlit věci, které zřejmé nejsou.
Každý vidí, že novou akci vytvoří tlačítkem „Nová akce“ a do kolonky „Titulek“ má napsat název akce. To není třeba komentovat nebo budiž, uveďte, chcete-li.
Vysvětlete ale hlavně, jak do vytvořené akce umístit jednoduše odkaz na fotogalerii z minulého ročníku akce, to možná běžného uživatele nenapadne, zvláště pokud v nabídce žádné tlačítko „Nová fotogalerie“ není a je třeba použít tlačítko „Hypertextový odkaz“ a předtím si z adresního řádku zkopírovat adresu galerie...
Příklad z jiné oblasti: Zabýváme se řazením rychlostních stupňů v automobilu:
Průměrně inteligentního člověka napadne, že když chce zařadit 1. rychlostní stupeň, má řadicí páku posunout k číslu 1.
Je pravda, že by bylo dobré upozornit, že musí mít sešlápnutou spojku, a poradit, kde řadicí páku najde.
Ale i to většina řidičů ví. Vaše práce by asi především měla poradit, v jakých situacích řadit který rychlostní stupeň, že optimálních 2500 otáček za minutu a jak tohoto stavu docílit.
Hmmm... a co je banální??? ;) Banální je to, co by měl znát průměrný absolvent naší školy. Není tedy třeba vysvětlovat podrobně to, co jste se učili ve škole.
