Obsah a styl odborných prací

Z MiS
(Rozdíly mezi verzemi)
Přejít na: navigace, hledání
(Jednoduchý styl, omezení vazeb mezi větami: Opraven nadpis, doplněn příklad)
(Doplnění příkladů, nepoužívat trpný rod.)
 
(Není zobrazena 1 mezilehlá verze od 1 uživatele.)
Řádka 1: Řádka 1:
<div class="Souvisejici">Související stránky: [[Harmonogram projektu]], [[Osnova dokumentace projektu]]</div>
+
<div class="Souvisejici">Související stránky: [[Harmonogram maturitní práce]], [[Osnova dokumentace maturitní práce|Osnova dokumentace]]</div>
[[Category:Maturitní projekt]][[Category:OA]][[Category:VSE]]
+
[[Category:Maturitní práce]][[Category:OA]][[Category:VSE]]
 +
 
  
 
== Co psát do dokumentace ==
 
== Co psát do dokumentace ==
 
* Co není v dokumentaci, jako byste nedělali.
 
* 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.  
+
<div class="Priklad">
 +
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í.
 +
</div>
 +
 
 +
* 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 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.
 
  
 +
== 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.
 +
<div class="Priklad">
 +
Místo: ''Výborně, máme nainstalovánu ústřednu. Nyní se můžeme pustit do hrátek s klientem...''
 +
<br />
 +
Pište: ''Ověříme funkčnost ústředny příkazem ... Dále je třeba nakonfigurovat klienta. Spustíme ...''
 +
</div>
 +
* 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í!!!
 +
<div class="Priklad">Nestačí: <em>Skype je pro běžného uživatele nejsnazší.</em> Uveďte konkrétní důvody, proč je snazší než jiné systémy. Nebo uveďte odkaz na zdroje, ze kterých to tvrzení čerpáte.</div>
 
<!-- <div class="Priklad">
 
<!-- <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...''
 
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...''
 
+
<br />
 
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ě.''
 
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> -->
 
</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">
 +
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ů...''
 +
</div>
  
<!-- <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.
 
 
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> -->
 
  
 
== Odborné termíny ==
 
== Odborné termíny ==
 
* Dbejte na správné použití odborných termínů z oblasti, o které píšete.
 
* 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í.
+
<div class="Priklad">
<!-- <div class="Priklad">
+
Ne: ''Stačí jen stáhnout, rozbalit a spustit.''
Před: ''Stačí jen stáhnout, rozbalit a spustit.''
+
 
<br />
 
<br />
Po: ''Pro instalaci webového serveru stačí stáhnout instalační balíček, rozbalit jej a spustit instalační program.''
+
Ale: ''Pro instalaci webového serveru stačí stáhnout instalační balíček, rozbalit jej a spustit instalační program.''
</div> -->
+
</div>
 
+
 
* Pokud existuje více termínů se stejným významem (synonyma), zvolte vždy jeden a používejte ho v celé práci.  
 
* 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.
+
* 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 ==
+
 
 +
== Spisovný jazyk, forma ==
 
* Používejte spisovný jazyk, vyhýbejte se hovorovým termínům.
 
* Používejte spisovný jazyk, vyhýbejte se hovorovým termínům.
 +
* '''Nepoužívejte trpný rod!'''
 +
<div class="Priklad">
 +
Nepište: ''Bude vyzkoušeno nastavení a bude zprovozněna i ústředna...''
 +
<br />
 +
Napište: ''Ověříme nastavení, zprovozníme ústřednu a vyzkoušíme následující scénáře: ...''
 +
</div>
 +
* '''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 ==
 
== Nadpisy ==
 
* Při volbě nadpisů se snažte, aby co nejlépe postihovaly skutečný obsah kapitoly.
 
* 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é.
 
* Zároveň by ale nadpisy měly být krátké.
 
+
<div class="Priklad">
<!-- <div class="Priklad">
+
 
Ne: ''Vzhled stránky''
 
Ne: ''Vzhled stránky''
 
<br />
 
<br />
 
Ale: ''Tvorba šablony vzhledu''
 
Ale: ''Tvorba šablony vzhledu''
</div> -->
+
</div>
 
+
<div class="Priklad">
<!-- <div class="Priklad">
+
 
Ne: ''Menu''
 
Ne: ''Menu''
 
<br />
 
<br />
 
Ale: ''Tvorba struktury menu''
 
Ale: ''Tvorba struktury menu''
</div> -->
+
</div>
  
 
== Nepište banality ==
 
== 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.
 
* Neztrácejte čas popisováním zřejmých věcí! Snažte se vysvětlit věci, které zřejmé nejsou.
 
 
<div class="Priklad">
 
<div class="Priklad">
 
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.  
 
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.  
 
+
<br />
 
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...
 
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...
 
</div>
 
</div>
 
 
<div class="Priklad">
 
<div class="Priklad">
 
Příklad z jiné oblasti: Zabýváme se řazením rychlostních stupňů v automobilu:
 
Příklad z jiné oblasti: Zabýváme se řazením rychlostních stupňů v automobilu:
 
+
<br />
 
Průměrně inteligentního člověka napadne, že když chce zařadit 1. rychlostní stupeň, má řadicí páku posunout k číslu 1.  
 
Průměrně inteligentního člověka napadne, že když chce zařadit 1. rychlostní stupeň, má řadicí páku posunout k číslu 1.  
 
+
<br />
 
Je pravda, že by bylo dobré upozornit, že musí mít sešlápnutou spojku, a poradit, kde řadicí páku najde.  
 
Je pravda, že by bylo dobré upozornit, že musí mít sešlápnutou spojku, a poradit, kde řadicí páku najde.  
 
+
<br />
 
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.
 
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.
 +
</div>
 +
<div class="Poznamka">
 +
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.
 
</div>
 
</div>
  
 
<!-- == Poděkování ==
 
<!-- == Poděkování ==
Uváděné příklady vychází z větší části z maturitních projektů žáků Pavla Bočka, Magdalény Špundové, Michaely Švecové, Lucie Bořecké, Adély Koníčkové a dalších. Za souhlas s použitím děkuji!  
+
Uváděné příklady vychází z větší části z maturitních prací žáků Pavla Bočka, Magdalény Špundové, Michaely Švecové, Lucie Bořecké, Adély Koníčkové a dalších. Za souhlas s použitím děkuji!  
 
-->
 
-->

Aktuální verze z 29. 3. 2014, 10:11


Obsah

Co psát do dokumentace

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í.


Pište stručně, jasně a přesně

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 ...

Nestačí: Skype je pro běžného uživatele nejsnazší. Uveďte konkrétní důvody, proč je snazší než jiné systémy. Nebo uveďte odkaz na zdroje, ze kterých to tvrzení čerpáte.

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

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.


Spisovný jazyk, forma

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: ...

Nadpisy

Ne: Vzhled stránky
Ale: Tvorba šablony vzhledu

Ne: Menu
Ale: Tvorba struktury menu

Nepište banality

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.


Osobní nástroje
Jmenné prostory
Varianty
Akce
Výuka
Navigace
Nástroje