Tipy pro dobrý styl

Toto je několik rad, jak napsat dobrou stránku na wiki.



1. Struktury stránek


  • Stránku začněte nadpisem první úrovně s výstižným názvem.
  • Vkládejte úrovně nadpisů ve správném pořadí, sekce druhé úrovně by měly začínat nadpisem druhé úrovně.
  • Rozdělte text na odstavce tak, že mezi nimi ponecháte prázdný řádek. Průměrný odstavec by neměl být delší než 10-20 řádků.
  • Pokud je váš text delší než několik (3-5) odstavců, zvažte jeho rozdělení do sekcí přidáním nadpisů druhé až páté úrovně.
  • Pokud je váš text delší než 2-3 stránky, umístěte za první nadpis krátký výtah obsahu stránky. Když bude vaše stránka výrazně delší, zvažte její rozdělení na více stránek.
  • Pokud máte mnoho odkazů na jiné stránky wiki nebo externí zdroje, přidejte zvláštní oddíl s dalšími odkazy (viz níže).
  • Pokud většina stránek jmenného prostoru sdílí společnou strukturu, přidejte šablonu jmenného prostoru, aby každá nová stránka mohla začínat s touto kostrou struktury.
  • Snažte se vyhnout příliš komplikovaným strukturám jmenných prostorů. Snažte se používat krátké, snadno zapamatovatelné názvy jmenných prostorů.

2. Formátování textu


  • Zdůrazněte jednotlivá slova nebo krátké úseky textu použitím tučného písma nebo kurzívy. Vyberte si jednu z nich a držte se své volby.
  • Zvolte si styl pro znázornění výstupu na obrazovku a textu na obrazovce, jako jsou tlačítka nebo popisky nabídek, a důsledně jej používejte. Možná by bylo dobré přidat na wiki stránku s vysvětlením konvencí stylů.
  • Používejte neuspořádané seznamy pro příkazy, které jsou na sobě nezávislé. Pokud rozvíjíte myšlenkovou linii, pište v souvislém sledu vět.
  • Poznámky pod čarou používejte střídmě a pouze pro velmi krátké doplňující poznámky. Pokud chcete k určitému tématu říci mnohem více, vložte to na novou stránku wiki. Pokud chcete odkázat na jiné (externí) zdroje informací, používejte raději odkazy.
  • Tabulky mohou výrazně zlepšit čitelnost strukturovaných dat. Pokud vkládáte tabulku, ujistěte se, že má smysluplné záhlaví buněk a opatřete ji popiskem, který jasně uvádí obsah tabulky (např. "Tabulka 1.2: Průměrné vzdálenosti mezi planetami").
  • Velké tabulky se obvykle velmi špatně upravují. Zvažte, zda místo toho nepředstavovat její data ve vnořeném seznamu.

3. Jazyk


  • Pište správné věty a v případě potřeby používejte členy u podstatných jmen.
  • Každou větu začínejte velkým písmenem a ukončete ji tečkou nebo jiným vhodným interpunkčním znaménkem.
  • Snažte se psát krátké, jasné věty bez přílišného využívání vedlejších vět. Když si myslíte, že jste stránku dokončili, přečtěte si ji znovu a opravte každou větu, která má příliš složitou strukturu.
  • Rozhodněte se, jakým způsobem budete oslovovat čtenáře. Vzhledem k tomu, že Wiki je zaměřena na psaní dokumentace, budete často muset své čtenáře instruovat, jak mají určité věci dělat. Můžete použít rozkazovací způsob ("Udělejte to!"), způsob my/ty ("Pak my/ty klikneme na...") nebo způsob já ("Pak přidám foo do baru, pomocí..."). Tyto formy nemíchejte.
  • Před uložením stránky zkontrolujte, zda na ní nejsou gramatické nebo pravopisné chyby. Pokud bude váš text vykazovat mnoho chyb, sníží to důvěryhodnost vašich tvrzení bez ohledu na to, jak dobře jsou promyšlená.
  • Vytvořte si vlastní styl. Nenuťte se psát způsobem, který vám není příjemný. Znělo by to jen nepřirozeně a nepříjemně by se to četlo.

4. Reference


  • Když narazíte na termín, který potřebuje podrobnější vysvětlení, přidejte pro něj novou stránku na wiki a odkažte na ni.
  • Než stránku dokončíte, znovu ji zkontrolujte a přidejte odkazy na existující wiki stránky k ústředním termínům své stránky.
  • Nepřidávejte odkaz na každý výskyt určitého termínu. Udělejte odkaz na první/nejvýraznější výskyt na stránce a možná přidejte odkaz na referenční sekci.
  • Uveďte odkazy na zdroje obrázků, dat a citací.
  • Zvažte přidání řádku "Viz také:" na konec stránky. Uveďte tam odkazy na stránky wiki, které úzce souvisejí s tématem vaší stránky.
  • Pokud chcete uvést odkazy na externí zdroje, které obsahují další informace k vašemu tématu nebo které jste použili při psaní stránky, přidejte na konec oddíl "Odkazy" nebo "Další informace" a uveďte seznam odkazů nebo jiné odkazy (např. čísla ISBN). Pokud jste tak již neučinili v hlavním textu, uveďte záměr odkazu.
  • Nastavení interwiki zkratek může pomoci při odkazování na běžné zdroje.

5. Obrázky a další média


  • "Obraz řekne víc než tisíc slov." Může dokonce znamenat více, než jste chtěli říci. Lidé mají tendenci zpochybňovat autenticitu obrazů méně než jazyka. Krátký textový popis je lepší než nepřesný obrázek.
  • Stejně jako u tabulek i u obrázků vždy uvádějte popisek, který uvádí, co chcete obrázkem ukázat.
  • Pokud jste obrázek nevytvořili sami, uveďte zdroj (případně odkaz) a autorská práva.
  • Nepřidávejte odkazy na obrázky z externích stránek, pokud to není výslovně povoleno. Je to jednak otázka autorských práv, ale může to být také otázka krádeže šířky pásma, pokud je vypnuto ukládání externích obrázků do mezipaměti.
  • Pokud je obrázek větší než zhruba třetina stránky, použijte odkaz s pokyny pro změnu velikosti a vložte miniaturu.

Read comments (0 comments)