Jak vytvořit návod

napoveda
Jak psát srozumitelně

Návody patří primárně na tuto wiki.

Návody se umísťují do jmenného prostoru /navody/ - tam je mohou upravovat všichni členové.

Pokud jsou některé návody zásadní a zodpovědný tým nechce, aby mu na ně někdo šahal, má si je umístit do svého jmenného prostoru /navody/, například po/navody/.

Každý návod, aby bylo možno jej dobře v budoucnu dohledat a udržovat, je třeba označit štítkem.

Štítek je kus kódu, který se vkládá na začátek, nebo na konec návodu a obsahuje základní informace, které umožňují ho mezi návody vyhledávat. Vzorový kód štítku je zde:

<hidden onHidden="Zobrazit štítek" onVisible="Skrýt  štítek">
---- dataentry navod ----
složka_page : po:start              # organizační složka odpovědná za činnost
osoba_page : lide:vojtech_pikal # člověk nebo funkce zodpovědný za údržbu návodu
adresáts    : Členové odborů, místní předsednictva # vymezení osob, jimž je návod určen
tags        : návody #seznam kategorií (tagů), kterých se návod týká
stav_wiki   : <color red>nedokončený</color> # stav návodu, možné barvy: red, orange, yellow, lightgreen, darkgreen
aktualizace_date : 21.02.2020 # datum poslední aktualizace textu návodu
----
</hidden>
Na tento návod odkazují [[?do=backlink|tyto stránky]].
{{page>navody/stitek}}

Složka udává adresu orgánu nebo týmu strany, který návod zpravuje a je zodpovědný za činnost, která je návodem popisována.

Většinou se jedná o odbory; po:start pro Personální odbor, ao:start pro Administrativní, to:start pro Technický a fo:start pro Finanční tým. Nic samozřejmě nebrání například krajským sdružením nebo republikovému výboru mít návod. I rozhodčí komise jeden má.

Osoba odkazuje ne někoho, kdo návod napsal, nebo jej udržuje. Pokud návod vytváříte, uveďte sebe. Pokud máte návrhy na zlepšení, napište jim.

Adresát obsahuje seznam skupin osob, kterým je návod určen. Například „členové“, „nováčci“, „oblastní předsednictva“, „dárci“, „předsedající“.

Tags je seznam témat, kterých se návod týká, například „systémy“, „předsedání“, „členství“ a podobně.

Seznamy adresátů a témat(tagů) jsou k dispozici zde.

Stav se snaží shrnout kvalitu návodu pomocí jedné barvy.

• červeně jsou označeny návody, které jsou špatně, nepravdivé, velmi zastaralé a postupovat podle nich je nemožné nebo nebezpečné.
• oranžově jsou označeny návody zastaralé či zásadně nekompletní
• žlutě jsou označeny návody částečně zastaralé či nekompletní
• zelené návody jsou v pořádku, pravdivé, aktuální a přiměřeně úplné.
• tmavě zelené návody jsou nejen v pořádku, ale i všechny návody a podobné stránky, na které odkazují jsou v pořádku.

• Návody

Na tento návod odkazují tyto stránky.