====== Tvorba návodů ====== ===== Co jsou návody ===== Návod je v podstatě popis určitého procesu. Proces potom je postupný tok dějů, stavů, aktivit nebo práce. Celý svět je pak v podstatě tvořen určitými procesy včetně Vašeho života a Piráty nevyjímaje. **Návod tedy může být prakticky na cokoli.** Jakákoli dobrá praxe, která by mohla někomu dalšímu posloužit, může být návod. Nemusí se jednat výlučně o nové systémy a administrativní procesy. Může jít o návod jak efektivně rozdávat pirátské listy, nebo postavit lavičku z palet, zorganizovat komunitní akci, či [[https://psychologie.cz/jak-prestat-byt-na-jednu-pres-drzku/|jak přestat být na jednu přes držku ]]:-). ===== Jak vytvořit návod ===== Následující seznam Ti stručně představí, jak na tvorbu návodů a co je pro to potřeba: **CHUŤ S NÁMI TVOŘIT** - tohle je zdaleka nejdůležitější ;-)! - Najděte si **téma**. Pokud máte pocit, že na něco chybí návod, nejprve se podívejte, [[/navody/start|zda je tomu opravdu tak]]. Je možné, že již nějaký návod existuje a třeba stačí upravit. FIXME Pokud máš chuť tvořit, ale téma Tě nenapadá, [[/po/start|ozvi se PO]], nasměruje Tě. Určitě je fajn, když dané problematice rozumíte, nebo máte někoho, na koho se můžete obrátit a obsah si s ním vykomunikovat. - Najděte výstižný **název** a v úvodu stručně popište **cíl návodu**. Určete si **pro koho** návod píšete (Adresát). - Určete si **v čem** návod napíšete. Ideální je psát přímo zde na wiki. Ale je možné ho vytvořit i jinde ([[https://pad.pirati.cz|klidně i v padu]]) a následně na něj odkázat PO a požádat o jeho začlenění do struktury návodů. - **Proces**, který budete popisovat, si **reálně projděte a vyzkoušejte**. Přemýšlet na jeho jednotlivými kroky. - **Vytvořte si strukturu** toho, co by měl daný návod obsahovat. Měl by být kompletní a uchopitelný. Bodům dejte logické pořadí. - **Rozpracujte jednotlivé body** tak, aby byly stručné ale dostatečně vypovídající. - Návod po sobě **znovu projděte** a jednotlivé kroky zkontrolujte a sami **vyzkoušejte**. - Do návodu **připojte také tipy a varování**, které uživatelům pomohou se snazším ovládnutím dané věci. - Pokud je to žádoucí, **připojte do návodu obrázky** s čísly a popisem pro lepší demonstraci jednotlivých kroků. - Návod po sobě **zkontrolujte**, naformátujte a vytvořte obsah ((na wiki se obsah tvoří automaticky podle struktury nadpisů)). - Návod ideálně na někom **otestujte**, abyste měli jistotu, že je pro ostatní uchopitelný. - **[[jana.kolarikova@pirati.cz|Dejte nám vědět]]**, že jste vytvořili nový návod a [[https://forum.pirati.cz/viewtopic.php?f=632&t=51487|informujte o něm]] ostatní. ===== Jak napsat ===== Ovládnout wiki, není nic složitého. Mrkněte na [[navody:wiki_napoveda|toto video]]. Další tipy a podbrobnosti, [[/ao/navody/text|jak psát text]]. Povídání PO o [[https://docs.google.com/document/d/1T3nAFReA4ztR-7_9obKo3Gj3Df4U6vfvvawzZ2bLLfU/edit?usp=sharing| procesech]] a tom, proč je dobré je mít popsané. ===== Správné zařazení a označení ===== ==== Umístění ==== 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/''. Pokud nevíte, jak založit novou stránku, čtěte ve [[wiki_faq#jak_muzu_zalozit_novou_stranku|wiki FAQ]]. ==== Štítek ==== 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: ---- 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 : nedokončený # stav návodu, možné barvy: red, orange, blue, lightgreen, darkgreen aktualizace_date : 21.02.2020 # datum poslední aktualizace textu návodu ---- Na tento návod odkazují [[?do=backlink|tyto stránky]]. {{page>navody/stitek&nofooter}} ==== Obsah štítku ==== **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 [[/law/navrhy/faq|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 "předsedání", "členství", případně systémů, které popisuje, například "fórum", "redmine". Stránky jednotlivých [[to:technicke-systemy|technických systémů]] odkazují návody s tagem shodným s názvem jejich stránky s mezerami a diakritikou. Příkladem může být [[to:technicke-systemy:wiki]] (tag "wiki") nebo [[to:technicke-systemy:forum]] (tag "fórum"). Seznamy adresátů a témat (tagů) jsou k dispozici [[navody:lists|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í * modře 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. ---- dataentry navod ---- složka_page : po:start # stranický tým zodpovědný za činnost adresáts : člen odboru, místní předsednictvo # vymezení osob, jimž je návod určen osoba_page : lide:vojtech_pikal # člověk nebo funkce zodpovědný za údržbu návodu tags : návody # seznam kategorií (tagů), kterých se návod týká stav_wiki : nekompletní # Stav návodu, možné barvy: red, orange, blue, lightgreen, darkgreen aktualizace : 21.02.2020 # datum poslední aktualizace textu návodu ---- Na tento návod odkazují [[?do=backlink|tyto stránky]]. {{page>navody/stitek&nofooter}}