Štábní kultura

Tato stránka obsahuje návrh pravidel, doporučení a zvyklostí, jaké bychom rádi udržovali při tvorbě české dokumentace. Neváhejte k obsahu diskutovat, zde uváděná pravidla by měla být výsledkem všeobecného konsensu.

Pravopis

Je podmínkou, aby zde vložený obsah odpovídal pravidlům spisovné češtiny. Pakliže narazíte na překlep či chybu, prosím, opravte ji. Pakliže pravidla spisovné češtiny připouštějí více možných variant (např. diskuse x diskuze), je vhodné držet se varianty, která se používá ve standardním balíku češtiny cs_urf8, případně je volba na autorovi textu.

Pojmenovávání stránek

Stránky se umisťují do adresářů, např. Správa, Moduly nebo Kurz a podle toho se pojmenovávají, např. Správa/Obecné parametry, Moduly/Databáze nebo Moduly/Studijní materiál/Typy studijních materiálů.

Stránky pojmenovávejte pokud možno srozumitelně a výstižně, ne ovšem zbytečně dlouze:

• Pole - příliš krátké a nevýstižné; zmatečné; zavádějící
• Pole pro vložení dat v databázi - příliš dlouhé
• Pole databáze - vhodný název pro dostatečně vymezenou i obsáhlou problematiku

Při vytváření odkazu na stránku dbejte, aby nově vytvářená stránka mohla být někým zdokumentována, tzn. její téma musí být dostatečně jasně vymezeno, případně bude stránka tvořit rozcestník na podrobnější témata. Na druhou by se samostatná stránka neměla týkat vyložené banality (např. "Kliknutí na tlačítko Přihlásit se").

V názvech stránek používejte české znaky:

• Sablona databaze
• Šablona databáze

Všechny stránky se umisťují do hlavního jmenného prostoru, takže v jejich názvech se nesmí vyskytovat dvojtečka.

Kategorie stránek

Stránky se zařazují do kategorií výlučně pomocí k tomu vytvořené šablony, pakliže není zvláštní důvod udělat to jinak. Stránka šablony a stránka kategorie jsou mezi sebou provázány odkazy. To zjednodušuje správu stránek, vkládání společných navigačních prvků do všech stránek v rámci stejné kategorie apod.