Obsah a styl odborných prací

Z MiS
Verze z 29. 3. 2014, 10:11; Spravce (diskuse | příspěvky)
(rozdíl) ← Starší verze | zobrazit aktuální verzi (rozdíl) | Novější verze → (rozdíl)
Přejít na: navigace, hledání


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