Pokud si píšete dokumentaci a ptáte se, proč Vaše dokumentace není přijata, tak se ujistěte, že jste splnili všechny následující body. V případě, že ne, tak víte, kde je problém.
Dostupnost:
- Dokument musí být dostupný online, doporučuji využívat Google Dokumenty
- Dokument nesmí obsahovat podezřelé zdroje
- V případě využití externích souborů musí mít tyto soubory formát PDF, aby se dokument nezměnil z důvodu nekompatibilních verzí prohlížečů
- Pokud chcete podrobné vysvětlení, kde máte chybu, tak u online dokumentu zapněte možnost komentovat
Stylistika:
- Celý dokument musí mít jednotný font
- Udržujte odstavce a stejná zarovnání
- V případě stránkování nepoužívejte „Enter”, ale řádné zakončení
- Nadpisy a podnadpisy mějte označené pomocí funkce (stylu), ne manuálně
- Pokud používáte barvy, tak obezřetně, nechceme mít omalovánky
- Každý dokument musí mít:
- Úvodní stránku s názvem, logem a verzí dokumentu
- Předmluvu
- Osnovu
- Obsahovou část
Gramatika:
- Vyvarujte se alespoň očividných chyb, minimálně používejte automatické opravy
- Žádné vulgární, ani slangové výrazy
- V případě, že píšete dokument, tak v jednom jazyce (CZ/SK), nikoliv namíchaně
- Pokud popisujete jakoukoliv věc na serveru, tak srozumitelně a používejte i rozvinutá souvětí
Obsah:
- Dokument je shrnutí celku, takže se do něj píší i věci, co se plánují do budoucna
- V případě, že uvedete položku, tak dodejte i popis, nikdy se neodkazujte na předchozí sekce
- Pokud popisujete čas, tak si musíte být vědomi reálně potřebného času k uskutečnění
- Pokud popisujete Vaše finanční zhodnocení, tak je potřeba je zhodnotit dle položek, nikoli jen jako celek
- Pokud počítáte s týmem, můžete dopsat i momentálně volné pozice
- Dbejte na to, aby informace, které dodáváte, byly pravdivé
- Popisujete-li co Vás odlišuje, tak se ujistěte, že to tak je a nepíšete nepravdivé či zcela běžné informace
- Odkazujete-li na externí zdroje, tak je prosím přidejte jako URL adresu
- Pokud máte možnost, tak text podkládejte obrazovým materiálem
- Dokument není statický, měl by se s vývojem doplňovat
Autorská práva:
- Pokud používáte jakkoliv pozměněnou verzi templatu, tak je zapotřebí zachovat jména, která tam jsou uvedena
- V případě potřeby si můžete do předmluvy uvést Vaše znění, ale Hicoria Hosting s.r.o. musí mít vždy právo na použití
- Veškeré materiály, včetně myšlenek, musí být Vaše, v případě, že nejsou, uveďte je prosím jako zdroj či vliv
- Aby nemohlo dojít k poškození z naší strany, nikdy neudělujte práva na editaci dokumentu pro pracovníky Hicoria (maximálně možnost komentovat)