Guidelines

Editovat

Při psaní těchhle poznámek jsem se snažil (s proměnlivou mírou uspěšnosti) držet několika pravidel:

Stopařův průvodce ne Galaktická encyklopedie
  • Drž se formátu heslostručný popis.

  • Nepiš román.

  • Používej definition lists.

Upřednosťnuj hesla ze zadání

Nejprve popiš věci ze zadání a pak se teprve věnuj souvisejícím věcem.

Zdůrazňuj překryvy

Pokud se otázky někde překrývají zdůrazni to pomocí admonition. Nekopíruj obsah a neopakuj se.

Zdroje

Pokud je to možné, odkazuj na zdroje.

Využívej možností Asciidocu

Existují example blocks, admonitions, code blocks, atd. Využívej je, ať to není jenom nudný text.

Obrázky

Pokud se hodí, přidej obrázek. Nevkládej ale jen screenshoty ze slidů.

Humor

Pokud tě napadne vtipný ale srozumitelný způsob, jak něco napsat, použij ho.