Překlady této stránky:

Toto je starší verze dokumentu!

Máme zde vesměs tři druhy stránek:

  1. Kapitoly dokumentů (dokumenty jsou rozděleny na hlavní kapitoly a ty jsou samostatnými stránkami).
  2. Společné stránky jako jsou definice, apod.
  3. Stránky s kusy textů (především definice a společné texty) pro vkládání do dokumentů.

Základní pravidla psaní textů

  • Píšeme text neutrálně, tedy ani z pohledu čtenáře (v první osobě) ani z pohledu autora (tedy "oni musí").
  • Píšeme text v přikazovací dikci, tedy ne "aplikace budou muset být upraveny", ale "správci ISVS své systémy upraví, tak aby".
  • Pokud se kdekoliv vyskytne konkrétní instituce, uvádíme jí celým jménem (příklad "Ministerstvo vnitra") nebo zkratkou (příklad "MV"). Nikde raději nepoužíváme zkratku "ministerstvo" ve smyslu konkrétního ministerstva.
  • zkratky se snažíme používat tak, aby jejich využití na daném místě bylo srozumitelné. Ke zkratkám v rámci dokumentu pak vždy existuje jejich seznam s vysvětlením

Některé principy související s Wiki stylem práce

  • části dokumentů, kapitoly a podkapitoly a další hierarchie ručně nečíslujeme. Číslování se zajistí automaticky až při generování výsledných dokumentu. Navíc v případě každého náhledu na jednotlivou část dokumentů bude číslování řešeno samostatně
  • Pokud chceme vytvořit samostatnou stránku odkazující na nějakou společnou část pro více dokumentů (třeba Propojený datový fond), vždy se přesvědčíme, zda v dané stránce je obsah správně.
  • Pokud chceme vytvořit automaticky generovanou definici, buď se zeptáme Michala Rady jak se to dělá, nebo vytvoříme opravdu stránku s definicí, nesnažíme se definice psát do každého dokumentu textem.

Diskuze

Vložte svůj komentář: