Obsah a styl odborných prací

Z eKocka

🧩 Co je v dokumentaci = co jste opravdu dělali ✅

[editovat | editovat zdroj]
  • Pokud jste měsíc řešili problémy s ovladači síťové karty 🌐🛠️, uveďte je!
  • ❌ Nepopisujte všechny slepé uličky, které nevedly k cíli 🚫🌀
  • ⚡ Nejprve správné řešení: co funguje, jaké problémy bylo třeba vyřešit 🏆
  • Poté zmínit nepoužitelné varianty, aby se čtenář vyhnul stejným pastem 🕳️👀
  • ❌ Nepište obecné banality z fór (150× opakované) 🙃
  • ✅ Pište jen to, co jste skutečně zjistili sami 💡💥

✍️ Pište stručně, jasně, přesně 💨🦾

[editovat | editovat zdroj]
  • Jednoduchý styl → vynechte ozdobné fráze ✂️🌸
  • ❌ Místo: „Výborně, máme nainstalovánu ústřednu…“
  • ✅ Pište: „Ověříme funkčnost ústředny příkazem …, dále nakonfigurujeme klienta“ 💻🛠️
  • Složitá souvětí → rozdělte na kratší věty 🧩
  • Buďte konkrétní a přesní 🎯
  • ❌ Nestačí: „Skype je pro běžného uživatele nejsnazší“
  • ✅ Uveďte důvody a zdroje 🌐📚

🧠 Odborné termíny ⚡📖

[editovat | editovat zdroj]
  • Správné použití odborných termínů 🛠️
  • ❌ „Stačí stáhnout, rozbalit a spustit“
  • ✅ „Pro instalaci webového serveru stáhneme instalační balíček, rozbalíme a spustíme instalační program“ 💻🖱️
  • Synonyma → vyberte jeden termín a používejte ho konzistentně 🔄

🗣️ Spisovný jazyk, forma 🎓

[editovat | editovat zdroj]
  • Vyhněte se hovorovým výrazům 🗨️❌
  • Nepoužívejte trpný rod 🙅‍♂️
  • ❌ „Bude vyzkoušeno nastavení a bude zprovozněna ústředna…“
  • ✅ „Ověříme nastavení, zprovozníme ústřednu a vyzkoušíme scénáře“ 🔧
  • Pište v množném čísle 👥 – vy + vedoucí práce 😉

🏷️ Nadpisy 🎨

[editovat | editovat zdroj]
  • Krátké, výstižné, odpovídají obsahu kapitoly 🏁
  • ❌ „Vzhled stránky“ → ✅ „Tvorba šablony vzhledu“
  • ❌ „Menu“ → ✅ „Tvorba struktury menu“

🚫 Nepište banality ❌💨

[editovat | editovat zdroj]
  • Neztrácejte čas popisem zřejmých věcí ⏳
  • Popište, co nenapadne běžného uživatele 🤯
  • Např. vložení odkazu na fotogalerii z předchozí akce 🖼️🔗
  • Auto → řazení rychlostí 🚗⚙️
    • Nepopisujte: posun páky k číslu 1
    • ✅ Upozorněte: sešlápnutá spojka, optimálních 2500 ot./min 💡

⚡ Co je banální?

[editovat | editovat zdroj]
  • Co by měl vědět průměrný absolvent školy 🎓
  • Není třeba vysvětlovat učebnicové základy 📚