Obsah a styl odborných prací
(Přidáno Co psát...) |
(→Jednoduchý styl, omezení vazeb mezi větami: Opraven nadpis, doplněn příklad) |
||
| Řádka 10: | Řádka 10: | ||
** Vysvětlete problémy a popište správné řešení. | ** Vysvětlete problémy a popište správné řešení. | ||
| − | == | + | == Pište stručně, jasně a přesně == |
| − | * Používejte jednoduchý styl, omezte složitost souvětí. | + | * Používejte jednoduchý styl, vyhněte se stylistickým ozdobám. |
| + | * Preferujte jednoduché věty, výrazně omezte složitost souvětí. | ||
* Snažte se omezit na strohá fakta, vynechte nepotřebné fráze. | * Snažte se omezit na strohá fakta, vynechte nepotřebné fráze. | ||
| + | |||
| + | <!-- <div class="Priklad"> | ||
| + | Ne: ''... Debian můžeme instalovat různými způsoby: z CD, z pevného disku, instalaci si můžeme spustit přes internet… Každý si může vybrat jaký typ mu vyhovuje. Nejběžnější je však použití instalačního CD s moderním instalátorem Debian Linuxu, tzv. Debian-installerem. Předpokládáme, že každý zvládne vypálit na svoje CD tento instalátor...'' | ||
| + | |||
| + | Raději: ''... Pro instalaci distribuce Debian můžeme využít klasické DVD, obraz ISO nebo dvě varianty CD se síťovou instalací. My použijeme CD s instalátorem pro instalaci ze sítě.'' | ||
| + | </div> --> | ||
| + | |||
* Omezte použití ukazovacích zájmen. Každá věta by měla nést informaci sama o sobě. | * Omezte použití ukazovacích zájmen. Každá věta by měla nést informaci sama o sobě. | ||
<!-- <div class="Priklad"> | <!-- <div class="Priklad"> | ||
| − | + | Ne: ''... umožní studovat funkčnost systému Joomla a upravovat ji podle potřeby. Využívají ji milióny webů...'' | |
| − | První zájmeno následuje hned po odpovídajícím názvu a je v rámci jedné věty. Druhé zájmeno už ale odkazuje do jiné věty. | + | První zájmeno následuje hned po odpovídajícím názvu a je v rámci jedné věty. Druhé zájmeno už ale odkazuje do jiné věty. |
| − | + | Raději: ''... umožní studovat funkčnost systému Joomla a upravovat ji podle potřeby. Redakční systém Joomla využívají milióny webů...'' | |
</div> --> | </div> --> | ||
Verze z 18. 3. 2012, 22:20
Obsah |
Co psát do dokumentace
- Co není v dokumentaci, jako byste nedělali.
- Neztrácejte tedy č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... ;)).
- Pokud jste měsíc řešili problémy s ovladači síťové karty, uveďte je.
- Nepopisujte ale všechny nepovedené cesty, které nevedly k cíli.
- Vysvětlete problémy a popište správné řešení.
Pište stručně, jasně a přesně
- Používejte jednoduchý styl, vyhněte se stylistickým ozdobám.
- Preferujte jednoduché věty, výrazně omezte složitost souvětí.
- Snažte se omezit na strohá fakta, vynechte nepotřebné fráze.
- Omezte použití ukazovacích zájmen. Každá věta by měla nést informaci sama o sobě.
Odborné termíny
- Dbejte na správné použití odborných termínů z oblasti, o které píšete.
- Snažte se být konkrétní a přesní.
- 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
- Používejte spisovný jazyk, vyhýbejte se hovorovým termínům.
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é.
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.
