ahoj, toto ještě není hotové, nepoužívat
Měnit Česko k lepšímu je radost. Činnost komunity Česko.Digital ale nemusí být srozumitelná všem. Projdi si tento stručný návod, aby se Ti podařilo dobře vysvětlit přínos projektu, který se má objevit na webu Č.D.
...
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
...
Na web Česko.Digital chodí různé cílové skupiny. Od nadšenců z komunity, přes novináře až po tvé kamarády. Ti všichni se dívají na popis projektů, aby pochopili, co děláme. Přibliž jim, proč se ostatní ve volném čase pustili právě do tohoto projektu.
Ne všechno, co je nám v komunitě jasné, je srozumitelné i veřejnosti.
Vyhni se odborným termínům a slangu.
💙 Mysli na to, za koho mluvíš
Přesto, že je projekt jedinečný, patří pod hlavičku Česko.Digital. Představ si, že je komunita člověk a ty popisuješ projekt jejími slovy. Dej stejně jako ona důraz na lidi, kteří za projektem stojí, a na přínos projektu pro celou společnost.
👋 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.
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á.
💡 Tip: Než začneš psát, 3 praktické informace:
Před text se pod obrázek automaticky objeví nadpis “O projektu”.
Pod popis projektu se automaticky vypisuje seznam hledaných rolí do projektu (pokud projekt někoho hledá).
Zvýrazňování je důležité, ale pokud v odstavci podtrhneš hned více věcí, oči to bolí. Zkus napsat tučně maximálně jednu věc v odstavci.
Projekty, na kterých pracujeme, popiš následovně:
Při psaní textů probíhajících projektů vycházíme z tohoto checklistu:
...
Projekty, které jsme předali nebo ukončili, popiš takto
Při psaní textů probíhajících projektů vycházíme z tohoto checklistu:
- Úvod
Vysvětli, jaký problém projekt řešil, proč se spojil s komunitou a co bylo jeho cílem. - Od nápadu k realizaci
Popiš, jak projekt vznikal, jakými prošel fázemi, z jakých studií nebo výzkumů vycházel. Je dobré uvést osvědčené postupy (design thinking, prototypování, testování, apod.), které byly použity a pomohly týmu ke zdárnému dokončení. - Dopad
Jednoznačně nejdůležitější informace. Desítky zapojených lidí a stovky hodin práce, jaký to má dopad? ČR se k lepšímu nezmění ze dne na den, je to dlouhá cesta. Zkus popsat, odkud a kam jsme se posunuli díky danému projektu.
| Expand | ||
|---|---|---|
| ||
|
- Doplň citace zadavatele a někoho z týmu expertních dobrovolníků
Ten nejlepší pohled ze zákulisí má ten, co to vymyslel a udělal. Neboj se zeptat zadavatele projektu na jeho zkušenosti nebo kohokoliv z týmu, co se naučil, co si odnáší apod.
Kam text uložit?
Všechny texty na web se propisují z databáze Airtable. Přístup ti dá Support Scrum Master nebo kdokoliv, kdo má na Slacku za jménem modré logo Č.D. Text k projektu se vkládá do posledního sloupce description a upravuje se v klasickém editoru. Pokud zakládáš zcela nový projekt, je třeba mu v této tabulce vytvořit nový řádek.
...
Není to jen o textu. Nezapomeň v Airtable tabulce vyplnit všechny sloupce. Díky tomu se na webu Česko.Digital budou zobrazovat odkazy na Jiru, Slack, GitHub, seznam koordinátorů apod.
...
✍ 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.
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
Pro větší přehlednost se neboj vložit obsah z Google Drive a použí makro Google Drive jako například zde.
Všechny extra funkce najdeš v plusku v horní liště
Inspiruj se články, které jsou srozumitelné a v tonalitě Česko.Digital: