Dokumentace bude praktická
Smyslem dokumentace není dlouhý obecný text. Musí být použitelná při reálné práci: instalace, aktualizace, kontrola verzí, release balík, changelog a opakovatelný postup vydání.
Instalace
Jak nahrát balík přes administraci Joomla, co zkontrolovat po instalaci a kde najít verzi balíku i podřízených rozšíření.
Update server
Jak Joomla načítá update XML, proč záleží na elementu, typu, client hodnotě a odkazu na instalační soubor.
Seznam změn
Jak má být changelog strukturovaný, aby Joomla zobrazila skutečné položky změn, ne jen prázdné okno.
Release
Jak vznikne balík, jak se pojmenuje, co musí obsahovat veřejné vydání a jak se ověří před zveřejněním.
Aktualizační scénář
- 1nainstalovat výchozí balík na Joomla 6.
- 2ověřit, že rozšíření obsahuje update server a changelog URL.
- 3publikovat metadata pro novou verzi.
- 4spustit kontrolu aktualizací v administraci Joomla.
- 5zobrazit seznam změn, provést aktualizaci a zkontrolovat výsledné verze.
Dokumentační checklist
- installpostup pro čistou Joomla 6 instalaci.
- updatepopis update serveru a kontrola dostupné verze.
- releasestruktura balíku a pravidla seznamu změn.
- mediascreenshoty z funkční demo instalace a typických výstupů.