README v open-source - jak reviewovat dokumentační PR

README je první věc, co uživatelé vidí když objeví tvůj projekt. Kvalitní dokumentace dělá rozdíl mezi úspěšným a ignorovaným open-source projektem.

Proč je dokumentace důležitá

• First impressions - README prodává tvůj projekt
• Onboarding - noví contributors potřebují jasné instrukce
• Troubleshooting - users hledají pomoc v docs
• API reference - developers potřebují detaily
• Migration guides - updaty vyžadují návody

Typy změn v dokumentaci

• Installation instrukce, requirements
• Usage příklady, code snippety, tutoriály
• API reference - funkce, parametry, return types
• Contributing guidelines
• Changelog, release notes
• Troubleshooting, FAQ

Můj review workflow

1. Někdo pošle PR - documentation update
2. Technical review - je to technicky správně?
3. Editorial review - gramatika, jasnost, formátování
4. Testing - jdou ty instrukce reálně provést?
5. Feedback - request changes pokud potřeba
6. Merge - approved do main

Co by mělo být v dobrém README

• Project description - jasné, co to řeší
• Installation - one-liner nebo step-by-step
• Quick start - minimální příklad jak začít
• Features - bullet list key capabilities
• Dokumentace - link na full docs
• Contributing - jak pomoct
• License - jasně uvedená
• Badges - build status, verze, downloads

Struktura dokumentace

• Getting Started - instalace, basic usage
• Tutorials - step-by-step pro běžné úkoly
• API Reference - detailní dokumentace funkcí
• Advanced Topics - deep dives
• Troubleshooting - common problems
• Contributing - code style, PR process
• Changelog - version history

Markdown formátování

• Headers - H1 pro title, H2 pro sekce
• Code blocks - syntax highlighting
• Links - interní navigace, externí resources
• Images - screenshoty, diagramy
• Tables - porovnání, feature lists
• Lists - bullet, numbered, checklists

Nástroje

• Git diff - pro Markdown soubory
• GitHub PR review - inline komentáře
• Vale linter - konzistentní terminologie
• Markdown preview - ověření formátování
• Broken link checkers - validace odkazů

Jak udržet docs aktuální

• Docs v code repository - verzuj s kódem
• CI checks - lint docs, verify links
• PR template - checklist "update docs if needed"
• Pravidelný audit - review quarterly
• Community contributions - přijímej opravy

---

Kvalitní dokumentace přitahuje uživatele a contributors. A diff je základ dobrého review procesu.

Reviewuješ README změny? Hoď Markdown do Markdown Diff.