Rady pro dobrý styl
Zde je několik rad, jak napsat dobrou wiki stránku.
Struktury stránek
Začněte svou stránku nadpisem první úrovně s smysluplným názvem.
Vnořte úrovně nadpisu do správného pořadí, oddíly ve druhé úrovni by měly začínat nadpisem druhé úrovně.
Rozdělte text do odstavců tak, že mezi nimi nechá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í na sekce přidáním nadpisů druhé až páté úrovně.
Když váš text dosáhne déle než 2-3 stránky na obrazovce, vložte za první nadpis krátký výpis obsahu stránky. Když se vaše stránka výrazně prodlouží, zvažte rozdělení na více stránek.
Pokud máte mnoho odkazů na jiné wiki stránky nebo externí zdroje, přidejte speciální sekci s dalšími odkazy (viz níže ).
Pokud většina stránek oboru názvů sdílí společnou strukturu, přidejte šablonu oboru názvů, takže jakákoli nová stránka může začít s touto strukturou kostry.
Pokuste se vyhnout příliš komplikovaným strukturám oboru názvů. Zkuste použít krátká a snadno zapamatovatelná jména oboru názvů.
Zvažte využití pluginu pro kontrolu kvality jako vlastníka nebo přispěvatele wiki, který vám pomůže při strukturování stránky a formátování textu.
Formátování textu
Zdůrazněte jednotlivá slova nebo krátké pasáže textu tučnou nebo kurzívou . Vyberte si jeden z nich a držte se svého výběru.
Vyberte styl pro reprezentaci výstupu obrazovky a textu na obrazovce jako tlačítka nebo popisky nabídek a používejte jej důsledně. Může být dobrý nápad přidat na svou wiki stránku s vysvětlením vašich stylů.
Pro příkazy, které jsou na sobě nezávislé, použijte seznamy bez řazení . Pokud vyvíjíte myšlenkovou linii, napište souvislou sekvenci vět.
Poznámky pod čarou používejte střídmě a pouze pro velmi krátké doplňující poznámky. Pokud se k určitému tématu dá říci mnohem více, umístěte jej na novou wiki stránku. Pokud chcete odkazovat na jiné (externí) zdroje informací, použijte odkazy .
Tabulky mohou výrazně zlepšit čitelnost strukturovaných dat. Pokud vložíte tabulku, ujistěte se, že má smysluplné záhlaví buněk a poskytněte titulek, který jasně uvádí obsah tabulky (např. „Tabulka 1.2: Průměrné vzdálenosti mezi planetami“).
Velké tabulky bývají velmi obtížně editovatelné. Místo toho zvažte zvážení jeho dat ve vnořeném seznamu.
Jazyk
Napište vlastní věty a v případě potřeby používejte články pro podstatná jména.
Začněte každou větu velkým písmenem a ukončete ji tečkou nebo jinou vhodnou interpunkcí.
Pokuste se napsat krátké, jasné věty, aniž byste se příliš spoléhali na podřízená ustanovení. Když si myslíte, že jste dokončili svou stránku, přečtěte si ji znovu a upravte každou větu, která má příliš komplikovanou strukturu.
Rozhodněte se, jak oslovit své čtenáře. Protože DokuWiki je zaměřen na psaní dokumentace, budete často muset své čtenáře poučit, jak dělat určité věci. Můžete použít rozkazovací tvar ( „ Udělej to!“), Přičemž my / vy tvoří ( „Tak my / vy click on …“) nebo I forma ( „ I přidejte foo na bar, s využitím …“). Nemíchejte tyto formy.
Než stránku uložíte, zkontrolujte gramatické chyby nebo pravopisné chyby. Pokud váš text vykazuje mnoho chyb, sníží to důvěryhodnost vašich prohlášení, bez ohledu na to, jak dobře jsou považovány.
Vytvořte si svůj vlastní styl. Nenuťte se psát způsobem, který vám není vyhovující. To by znělo jen nepřirozeně a bylo by nepříjemné číst.
Reference Když narazíte na termín, který vyžaduje další vysvětlení, přidejte k tomuto výrazu novou wiki stránku a odkaz na něj.
Před dokončením stránku znovu zkontrolujte a přidejte odkazy na existující stránky wiki do centrálních podmínek vaší stránky.
Nepřidávejte odkaz na každý výskyt určitého termínu. Proveďte první / nejvýznamnější výskyt na stránce odkazem a možná přidejte odkaz do referenční sekce.
Poskytněte odkazy na zdroje obrázků, dat a nabídek.
Zvažte přidání řádku „Viz také:“ na konec stránky. Na této stránce uveďte odkazy na stránky wiki, které úzce souvisí s tématem vaší stránky.
Pokud chcete dát odkazy na externí zdroje, které mají další informace k vašemu tématu nebo které jste použili při psaní své stránky, přidejte na konci sekci nazvanou „Odkazy“ nebo „Další informace“ a uveďte seznam odkazů nebo jiných ukazatelů ( např. čísla ISBN). Pokud jste tak dosud neučinili v hlavním textu, uveďte záměr odkazu.
Nastavení zkratek pro interwiki může pomoci s propojením na běžné zdroje.
Obrázky a další média
“Obrázek říká více než tisíc slov.” Mohlo by to dokonce znamenat více, než jste chtěli říct. 1) Lidé mají sklon zpochybňovat autentičnost obrazů méně než autentičnost jazyka. Krátký textový popis je lepší než nepřesný obrázek.
Stejně jako u tabulek vždy uveďte popis pro obrázky, který uvádí, co chcete s obrázkem zobrazit.
Pokud jste obrázek sami nevytvořili, uveďte zdroj (možná s odkazem) a autorská práva.
Nepropojujte obrázky z externích webů, pokud to není výslovně dovoleno. Toto je v první řadě otázkou autorských práv, ale může to být také otázka krádeže šířky pásma, když je ukládání externích obrázků do mezipaměti zakázáno.
Pokud je obrázek větší než zhruba třetina obrazovky, vložte miniaturu pomocí odkazu s pokyny pro změnu velikosti .