• @cen_f has upload permissions
  • @cen_ao has delete permissions
  • @cen_to has delete permissions
  • @cen_po has delete permissions
  • @cen_fo has delete permissions
  • @cen_zo has delete permissions
  • @ALL has read permissions
  • lukas.novy has no permissions
  • @administrator_-_vedouci_ao has delete permissions
  • lukas_novy has no permissions

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 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ší ;-)!

  1. Najděte si téma.

    Pokud máte pocit, že na něco chybí návod, nejprve se podívejte, 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á, 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.

  2. 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).
  3. 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 (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ů.

  4. Proces, který budete popisovat, si reálně projděte a vyzkoušejte. Přemýšlet na jeho jednotlivými kroky.
  5. 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í.
  6. Rozpracujte jednotlivé body tak, aby byly stručné ale dostatečně vypovídající.
  7. Návod po sobě znovu projděte a jednotlivé kroky zkontrolujte a sami vyzkoušejte.
  8. Do návodu připojte také tipy a varování, které uživatelům pomohou se snazším ovládnutím dané věci.
  9. Pokud je to žádoucí, připojte do návodu obrázky s čísly a popisem pro lepší demonstraci jednotlivých kroků.
  10. Návod po sobě zkontrolujte, naformátujte a vytvořte obsah 1).
  11. Návod ideálně na někom otestujte, abyste měli jistotu, že je pro ostatní uchopitelný.
  12. Dejte nám vědět, že jste vytvořili nový návod a informujte o něm ostatní.

Jak napsat

Ovládnout wiki, není nic složitého. Mrkněte na toto video.

Další tipy a podbrobnosti, jak vytvořit návod.

Povídání PO o 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/.

Š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:

<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, blue, 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}}

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 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 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 Wiki (tag „wiki“) nebo Fórum (tag „fórum“).

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í
  • 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.

Související informace

Zobrazit štítek

Skrýt štítek

složka:
Personální odbor
adresát:
členové odborů, místní předsednictva
osoba:
Bc. Vojtěch Pikal
tag:
návody
stav:
nekompletní
aktualizace:
21.02.2020

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

Toto je jeden z mnoha návodů.

21.02.2020 16:46 · vojtech.pikal
1) na wiki se obsah tvoří automaticky podle struktury nadpisů
© Piráti, 2020. Všechna práva vyhlazena. Sdílejte a nechte ostatní sdílet za stejných podmínek. Podmínky použití.