How To Contribute

Dokumentace slouzi autorum

aby nemuseli vse drzet v hlave
k usporadani vlastnich myslenek
jako podklad pro dalsi tvorbu
aby nemuseli stale vysvetlovat to same

Ale benefitovat z ni maji predevsim ostatni ctenari, kteri potrebuji snadno a rychle dohledat potrebne informace.

Patero

Nepiseme clanky na web a nejde nam o navstevnost. Nize uvedena doporuceni pomahaji psat texty, ktere se dobre vyhledavaji a rychle pomohou.

1. Budte strucni

Mene je skoro vzdy vice. Snazte se aby uz samotny obsah stranky byl funkcni treba jako postup. Snazte se na zacatku uvest to nutne a pokud to nejde, alespon v delsich textech zvyraznit to podstatne.

2. Spravne nazvy stranek

Neni duvod psat kratke, nebo bulvarni nazvy. Nazev stranky musi vystihnout o cem stranka je a pokud jeji obsah prestane souviset s nazvem, stranku rozdelte, nebo prejmenujte.

3. Spravne texty nadpisu a jejich struktura

Pokud index stranky sam o sobe neni navodny, manual je spatne napsany a nikdo ho nebude cist, vlastne se mozna tu stranku nepodari ani spravne vyhledat a je zbytecne ji vubec psat.

4. Nesetrete priklady

Ukazka pouziti je lepsi nez dva odstavce textu. Nesetrete jimi a i kdyz se vam zda pouziti jasne, premyslejte o tom kdo bude clanek cist.

5. Neopakujte se

je lepsi mit 13 oddelenych stranek s jasnym obsahem, nez 1 ktera obsahuje vse

piste stranky, ktere se daji pouzit v dalsich strankach
nepresahujte tema dane nadpisem
pouzivejte odkazy na dalsi stranky

Struktura a vyhledavani

Pokud organizujeme sve vlastni myslenky, poznamky atp, casto vytvorime a vyzname se ve velmi hluboke strukture. Pokud spolupracujeme ve vice lidech, zacne se vyskytovat problem s tim, ze ruzne stranky by mohli, nebo dokonce mely patrit do vice skupin a ruzni lide vnimaji ruzne aspekty trideni ruzne intenzivne.

Nasledkem toho je, ze kazdy hleda stejne informace na jinem miste, roste frustrace, nekdy to dokonce vede ke sporum a naslednemu zaskodnictvi.

Zatim nejfunkcnejsi, me znamou, prevenci je psani obsahu, ktery se dobre indexuje a pripadne je doplnen o vhodne tagy/stitky. A zbaveni se predstavy, ze nekdo bude proklikavat 7 urovni hluboky index, ktery snad dokonce i vsichni navstevnici pochopi. Na internetu uz dnes take snad nikdo nehleda klikanim v katalogu…

Tip

Drzime maximalne 2 urovne struktury. Tj. tvorime maximalne jeden adresar pod nasledujicimi kategoriemi.

\_ HowTo

postupy a reseni pozadavku
vystupy z post mortemu (jak resime problem, ktery uz se stal)

\_ Stack

Tato sekce je urcena primarne pro drzeni obecnych znalosti a muze znacne urychlit proces naboru novych clenu.

Topologie
Nastroje
Komponenty
Strategie a ideologie

\_ Lab

Zapisky z experimentu, ktere sme uskutecnili a treba jeste nepouzivame, nebo cekaji na dalsi investigaci.

Piste pro konzumenty

Tim hlavnim je pouzitelnost. Nezapominejte, ze dokumentaci pisete pro ty, kteri hledaji pomoc a nepremysli pravdepodobne jako vy, vyhnete se tedy prosim slozitym a hodne vnorenym strukturam. Radeji pouzivejte dostatecne popisna jmena a dobre volte jmena titulku ve vasich napovedach. Pomuze to dobre indexaci a tak lepsi dohledatelnosti.

Neduplikujte informace

Informace by meli byt vzdy na jednom miste, pokud jsou jiz neaktualni, upravte je. Pokud je potrebujete mit ve sve dokumentaci, odkazte se na ne

Pozor na citlive informace

Nevkladejte do dokumentace zadne pristupove udaje idealne ani jmena a kontakty na kolegy, nebo sebe. Nikdy nevite, kam se bue dokumentace dale rozsirovat a proto radeji pocitejte s tim, ze cokoli v dokumentaci uvedete je verejna informace.