Files
knowledge-base/REVIEW.md
Stanislav Hubacek c6fa0bff6a commit
2026-06-11 15:27:28 +02:00

2.6 KiB

📋 Review workflow — Oponentura a kontrola obsahu

Proces

Draft ──→ Self-review ──→ Peer review ──→ Approval ──→ Merged
  ↑                                                    │
  └────────────── Feedback loop ───────────────────────┘

Fáze

1. Draft

  • Autor vytvoří nový obsah / upraví existující
  • Označí soubory jako [draft] v poznámce commit message
  • Cíl: zachytit myšlenky, strukturu a fakta

2. Self-review (autor)

  • Je obsah srozumitelný? Pochopí to junior?
  • Jsou fakta správná? Ověřit proti sources / oficiální dokumentaci
  • Jsou uvedeny zdroje? (odkazy v sources/)
  • Je struktura konzistentní se zbytkem KB?
  • Jsou zkratky vysvětleny?
  • Pravopis a gramatika
  • Odpovídá tón — faktický, bez subjektivních názorů
  • Obsahuje actionable best practices, nejen teorii

3. Peer review (kolega / oponent)

  • Autor zažádá o review (PR / issue / @mention)
  • Oponent kontroluje:
    • Odborná správnost — jsou data a koncepty validní?
    • Úplnost — není něco důležitého vynecháno?
    • Nestrannost — neupřednostňuje jeden vendor bezdůvodně?
    • Aktuálnost — nejsou informace zastaralé?

Review template:

## Review: [název souboru]

### Odborná správnost
- [ ] Fakta jsou správná
- [ ] Doporučení jsou vhodná
- [ ] Uvedené zdroje jsou relevantní

### Struktura a forma
- [ ] Logické členění
- [ ] Konzistentní formátování
- [ ] Jazyk je srozumitelný

### Připomínky
- [ ] [připomínka 1]
- [ ] [připomínka 2]

### Verdikt
- [ ] Schvaluji
- [ ] Schvaluji s výhradami (viz připomínky)
- [ ] Zamítnuto (důvod: …)

4. Approval

  • Schvaluje: autor + minimálně 1 peer reviewer
  • Po schválení se obsah považuje za [done]
  • Změny po schválení vyžadují nový review cyklus

5. Merged / Published

  • Obsah je považován za aktuální a důvěryhodný
  • Pokud je zdroj označen [done] v sources/, je to potvrzení zpracování

Stavy souborů

Status Význam
[draft] Rozpracováno, neprošlo review
[in-review] Probíhá peer review
[done] Schváleno, aktuální
[outdated] Zastaralé, čeká na revizi
[deprecated] Nahrazeno jiným dokumentem

Pravidelná revize

  • Kvartálně — kontrola aktuálnosti celé KB
  • Trigger — nová verze nástroje, změna architektury, EOL technologie
  • Každý soubor by měl mít v patičce datum poslední revize