Dobrý styl

https://www.dokuwiki.org/tips:good_style

(Tipy pro dobrý styl psaní)

Zde je několik tipů, jak napsat kvalitní wiki stránku. Viz také tipy pro kvalitní obsah.

• Začněte stránku nadpisem první úrovně s výstižným názvem.
• Vnořte úrovně nadpisů ve správném pořadí – sekce druhé úrovně by měly začínat nadpisem druhé úrovně.
• Rozdělujte text do odstavců ponecháním prázdného řádku mezi nimi. 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í pomocí nadpisů druhé až páté úrovně.
• Pokud je text delší než 2–3 obrazovky, vložte krátké shrnutí obsahu stránky hned za první nadpis. Pokud je stránka výrazně delší, zvažte její rozdělení do více stránek.
• Pokud máte mnoho odkazů na jiné wiki stránky nebo externí zdroje, přidejte zvláštní sekci s dalšími odkazy (viz níže).
• Pokud většina stránek v určitém jmenném prostoru sdílí společnou strukturu, přidejte šablonu jmenného prostoru, aby každá nová stránka začínala stejnou kostrou.
• Vyhýbejte se příliš složitým strukturám jmenných prostorů. Používejte krátké, snadno zapamatovatelné názvy.
• Zvažte použití pluginu Quality Check jako správce nebo přispěvatel wiki pro pomoc se strukturou stránky a formátováním textu.

• Zvýrazněte jednotlivá slova nebo krátké pasáže pomocí tučného písma nebo kurzívy. Vyberte si jeden styl a držte se ho.
• Zvolte styl pro zobrazování výstupu na obrazovce, jako jsou tlačítka nebo názvy nabídek, a používejte jej konzistentně. Může být užitečné vytvořit stránku s vysvětlením vašich stylových konvencí.
• Používejte nečíslované seznamy pro nezávislé výčty. Pokud rozvíjíte myšlenku, pište v souvislém sledu vět.
• Používejte poznámky pod čarou střídmě a jen pro velmi krátké doplňující poznámky. Pokud je třeba říci více, vytvořte novou wiki stránku. Pro odkazy na jiné (externí) zdroje informací použijte 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 přidejte popisek, který jasně uvádí obsah tabulky (např. „Tabulka 1.2: Průměrné vzdálenosti mezi planetami“).
• Velké tabulky bývají obtížně upravitelné. Zvažte zobrazení dat pomocí vnořeného seznamu.

• Pište správné věty a používejte členy u podstatných jmen, pokud je to potřeba.
• Každou větu začněte velkým písmenem a ukončete 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 používání vedlejších vět. Až si budete myslet, že máte stránku hotovou, přečtěte si ji znovu a upravte věty, které mají příliš složitou strukturu.
• Rozhodněte se, jak budete oslovovat čtenáře. Protože je DokuWiki zaměřena na psaní dokumentace, často budete muset čtenáře instruovat, jak něco udělat. Můžete použít rozkazovací způsob („Udělejte to!“), formu my/vy („Pak klikneme/kliknete na…“) nebo formu já („Já pak přidám foo do bar pomocí…“). Tyto formy nemíchejte.
• Před uložením stránky zkontrolujte případné gramatické a pravopisné chyby. Pokud text obsahuje mnoho chyb, sníží to důvěryhodnost vašich tvrzení, bez ohledu na jejich kvalitu.
• Rozvíjejte vlastní styl. Nenuťte se psát způsobem, který vám není přirozený. Výsledkem by byl nepřirozený text, který se špatně čte.

• Pokud narazíte na pojem, který vyžaduje další vysvětlení, vytvořte novou wiki stránku a odkažte na ni.
• Před dokončením stránky ji znovu projděte a přidejte odkazy na existující wiki stránky k hlavním pojmům.
• Neodkazujte každý výskyt konkrétního pojmu. Odkazujte první nebo nejvýraznější výskyt na stránce a případně přidejte odkaz do sekce s odkazy.
• Uvádějte odkazy na zdroje obrázků, dat a citací.
• Zvažte přidání řádku „Viz také:“ na konci stránky. Uveďte odkazy na wiki stránky, které jsou úzce spojené s tématem vaší stránky.
• Pokud chcete odkázat na externí zdroje s dalšími informacemi k tématu nebo které jste použili při psaní stránky, přidejte sekci „Odkazy“ nebo „Další informace“ na konec stránky a uveďte seznam odkazů nebo jiných údajů (např. ISBN). Pokud jste záměr odkazu neuvedli v hlavním textu, uveďte jej zde.
• Nastavení interwiki zkratek může pomoci s odkazováním na běžné zdroje.

• „Obrázek řekne víc než tisíc slov.“ Může ale znamenat víc, než jste chtěli říct.¹⁾ Lidé mají tendenci méně zpochybňovat pravost obrázků než jazyk. Krátký textový popis je lepší než nepřesný obrázek.
• Stejně jako u tabulek vždy přidejte k obrázkům popisek, který uvádí, co chcete obrázkem sdělit.
• Pokud jste obrázek nevytvořili sami, uveďte zdroj (ideálně s odkazem) a autorská práva.
• Neodkazujte na obrázky z externích webů, pokud k tomu nemáte výslovné povolení. Jde především o otázku autorských práv, ale také o zátěž při přenosu dat, pokud je ukládání externích obrázků do mezipaměti zakázáno.
• Pokud je obrázek větší než přibližně třetina obrazovky, vložte miniaturu pomocí odkazu s pokyny pro změnu velikosti.