Jak psát učební texty

From Simulace.info
Jump to: navigation, search

Jak na to

Jednou z podmínek úspěšného dokončení našeho předmětu je semestrální práce. V současné době mívá buďto podobu článku pro Wikipedii na zadané téma nebo kapitoly z učebního textu pro tento předmět. Témata budou vypsána k registraci prostřednictvím ISISu v předem stanoveném a oznámeném termínu. Aby z toho něco bylo, bude Vaše kapitola uložena na tomto webu a používána dalšími generacemi coby učební pomůcka pro tento předmět. Váš text by tedy měl vypadat jako kapitola z učebnice. Ovšem pozor! Z dobré učebnice. Nestačí tedy jen text vyložit formálně správně po odborné stránce tak jako u encyklopedického článku, ale byste psát atraktivně, aby nad tím čtenář neusnul. Text by měl být doplněn souvisejícími zajímavostmi, poznámkami, obrázky, schématy, diagramy, infoboxy, apod. A rovněž příklady a cvičeními, na kterých je problém nejen demonstrován, ale kterých si může čtenář vyzkoušet pozozumnění tématu, popř. kterými se můžeme inspirovat při tvorbě testových otázek. Oproti situaci, kdy byste psali text určený k vytištění na papír je žádoucí využít schopností tohoto enginu a doplnit text odkazy buď na elektronické zdroje uvnitř i vně tohoto webu (ty nicméně nenahrazují korektní citace). Odkazovat se můžete (a je to velmi žádoucí) i na hesla a kapitoly, která ještě nejsou zpracovány, ale můžete očekávat, že v budoucnu zpracovány budou.

Orientační požadovaný rozsah je 14000 znaků a text musí samozřejmě důsledně splňovat veškeré parametry odborného textu, zejména podrobné citace (upozornění: wikipedie, stejně jako jakákoliv jiná encyklopedie je terciární zdroj a proto NENÍ v žádném případě citovatelná, ale to je asi na magisterském stupni zbytečné připomínat). Rozhodně se od Vás neočekává, že se budete obsahově či formálně držet struktury výkladu uvedeného v našich slidech. Naopak! U každého takto zadaného tématu jistě brzy zjistíte, že existuje obrovská spousta dalších souvisejících informací a jiných pohledů, než jsou ty, ze kterých jsme problematiku řešili my a bude jen žádoucí, pokud je zapracujete. Pokud zpracujete něco zajímavého, klidně o to naopak třeba náš výklad v budoucnu rozšíříme. Věříme, že to bude přínosem pro všechny, neboť člověk se nikdy nenaučí nic lépe, než když to vysvětluje někomu jinému. Držte jednotnou míru podrobnosti. Je možné, že v rámci Vašeho tématu existuje nějaké významné a rozsáhlé podtéma. Není nutné jej detailně zpracovávat - může tak učinit někdo jiný v budoucnu. V takovém případě v textu navrhněte příslušné podkapitoly.

Jako vzor, jak vypadají opravdu pěkné, názorné učebnice se doporučuji podívat spíše za hranice, v české kotlině jich je, bohužel, minimum. Pár linků pro inspiraci nabízím: zde, zde nebo v této knížce.

Při psaní čehokoliv prostřednictvím wiki každopádně doporučujeme rozpracovaný text často ukládat a nejlépe jej udržovat v kopii v notepadu nebo podobném nástroji. Dokud totiž není stránka uložena na serveru, může kdykoliv vypadnou spojení či nastat jiná neblahá událost, která spolehlivě zlikviduje Vaši mnohahodinovou snahu.

Doporučené náležitosti

Na rozdíl od simulací nepředipisujeme pevnější strukturu Vašeho textu, aby byl především čtivý. Přesto byste neměli zapomenout na následující náležitosti. Neznamená to ale, že je nezbytně nutné mít následující body přesně takto označené a v daném pořadí.

  • Úvod - velmi dobrým druhem úvodů jsou příklady z reality, které třeba s problémem na první pohled moc nesouvisejí, ale vy ukážete, že vlastně ano
  • Výklad problému, terminologie
  • Reálné aplikace
  • Řešený příklad (nejlépe více řešených příkladů, jeden jednodušší, další sofistikovanější)
  • Fakta s problémem související (další varianty, jak se daný fenomén využívá, apod.)
  • Zajímavosti týkající se problému
  • Zadání příkladů pro studenty, na kterých si mohou problém procvičit a příkladů, které by bylo možné použít v testu
  • Seznam referencí

Držte se tématu a nezapomínejte, že tvoříte součást většího díla. Dívejte se, jaké další kapitoly jsou vypsány (případně přemýšlejte, jaké vypsány logicky být mohou nebo je klidně do seznamu i směle přidejte). Pište tak, abyste pokryli myšlenku a nezasahovali příliš do jiných kapitol.

Jak práci odevzdávat

Odevzdání Vašeho textu je možné výhradně prostřednictvím příspěvku v sekci Učební texty tohoto webu. Nikoliv v souboru z textového editoru. Seznamte se prosím se syntaxí MediaWiki, abyste mohli využít všech jejích schopností. Je opravdu jednoduchá.

Jazykové verze

U odevzdávaných prací je žádoucí, aby byly prolinkovány texty stejného významu v různých jazycích (např. článek o metodě Monte Carlo psaný v češtině by měl mít jakousi vazbu na článek ke stejnému tématu psanému v angličtině). MediaWiki k tomu poskytuje nástroj, byť nepříliš dobrý (POZOR! Funguje to jinak než na Wikipedii.). Pro jednotnost je třeba vždy uvádět název hesla v angličtině (angličtina je považována za standardní jazyk) a bezprostředně za ním lomítko a ISO kód jazyka (v případě češiny "cs").

Budete-li tedy psát např. článek "Metoda Monte Carlo", pojmenujte jej "Monte Carlo Method/cs". V horním listboxu byste vždy měli mít vybrán jazyk, ve kterém chcete článek psát.

Aby nadpis českého článku nebyl v angličtině a ještě s podivným lomítkem, je třeba změnit nadpis článku pomocí "magického slova":

{{DISPLAYTITLE:''název stránky v kýženém jazyce''}}

V našem případě tedy uvedete na začátek textu následující kód:

{{DISPLAYTITLE:Metoda Monte Carlo}}

Při psaní nezapomeňte mít vybrán správný jazyk. Pokud Vám článek záhadně "zmizí", podívejte se nejprve, zda náhodou není uložen v angličtině.