Jak psát na Wiki

Tento návod Ti ukáže, jak psát články na wiki >č.d. Zjistíš zde, jak článek vytvořit, jaký jazyk v něm použít a celkově jakou by měl mít strukturu. 

Obsah

Vytvoř nový článek na Wiki

Pro psaní do Wiki jsou dva možné způsoby. Nejprve si vybereš složku, kam budeš chtít svůj článek napsat. 

  1. Po zvolení složky přesuneš kurzor na složky, klikneš na “+” a máš vytvořenou vlastní stránku. 

2. Druhý způsob spočívá v okopírování již vytvořené stránky. Tato možnost je jednodušší, strukturu článku už nemusíš od začátku stavět, stačí jen upravit text a strukturu případně přizpůsobit.

 

Pokud není stránka na 100% hotová, ale jedná se jen o návrh nebo pracovní verzi WIP - (Work in progress), pojmenuj jí tak, aby sotatní věděli, že se nejdná o finální podobu. Například - [WIP] Jak na Slack

Mysli na to, ke komu mluvíš

Přizpůsob text podle toho, kdo bude tvůj článek číst. Podle toho i používej odborné termíny a dávej si pozor na slang (viz slang ve slovníčku).

Před psaním textu se zkus naladit na archetyp značky a pročíst tonalitu Česko.Digital, která je upřímná, přátelská, podporující, optimistická a odvážná.

Popiš to přehledně

Odstavce - Je dobré si svůj článek rozdělit odstavci.  Jednodušeji se nám čte a rychleji v něm můžeme vyhledávat. 

Zvýrazňování - Důležité části textu zvýrazni (slova, termíny), ale nepřeháněj to, ideálně jednu věc na odstavec.

Emoji - Emoji ti pomohou článek oživit a zlepšit orientaci v textu. Používej je v nadpisech i klidně na konci vět. Dávej si ale pozor, aby ji nebylo příliš. Méně je někdy více.

Obsah - Je dobré na začátek článku vložit obsah. Lépe se poté v textu vyhledávají potřebné informace.

  1. Pro vytvoření obsahu na začátku stránky je nutné nejdřív publikovat samotný článek a až poté zkopírovat link názvu článku.

2. Následně vložíme link na začátek stránky do obsahu. 

 

3. Velikost nadpisu pro “OBSAH” nastavíme na Heading 2.

4. A máš hotovo!

Píšeš návod? Pár věcí, na který si dej bacha

  • mysli na to, kdo to bude číst - pokud píšeš návod pro programátory, neboj se použít jejich slang tak, aby to co nejlépe pochopili, dle cílovky může být text odbornější, ale ne složitý

  • dbej na to, aby struktura dávala smysl (na začátku řekni, k čemu návod je a pro koho apod.)

  • piš srozumitelně, počítej s tím, že návod může číst i juniornější kolega

  • uveď příklady z praxe ať je jasné, jak to “má vypadat”, dodej pomocné odkazy a neboj se návod oživit o grafické schéma/graf/ilustraci tak, aby bylo jasné, co chceš sdělit

A na závěr obecné tipy