---
title: Guidelines
description: Guidelines for contributing notes
---

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 _heslo_ -> _struč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.
