Skip to content

Commit 617b02f

Browse files
committed
CZ, EN : Update in README TOC list, Versioning strategy described
1 parent dca64ae commit 617b02f

File tree

2 files changed

+15
-4
lines changed

2 files changed

+15
-4
lines changed

cs/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Dokumentace pro autory
22

33
Cílem dokumentace je popsat:
4-
- postupy pro tvorbu vlastní nápovědy,
5-
- vnitřní formát metadat,
6-
- významná specifika HelpViewer a jeho procesů,
7-
- přístupy pro integraci mezi aplikacemi a nápovědou
4+
- Postupy pro tvorbu vlastní nápovědy,
5+
- Vnitřní formát indexací a metadat,
6+
- Významná specifika HelpViewer a jeho procesů,
7+
- Přístupy pro integraci mezi aplikacemi a nápovědou
8+
- Přehled struktury GitHub organizace HelpViewer a popis verzování
9+
- Popis možností rozšíření samotného projektu

cs/helpviewer.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,15 @@ Repozitáře bývají pojmenovány **help\***. Vzhledem k pojmenování projektu
2828
| [helpUser][RhelpUser] | Nápověda pro uživatele prohlížeče. Popisuje základní práci s prohlížečem. |
2929
| [helpAuthorsGuide][RhelpAuthorsGuide] | (Tato) Nápověda pro autory nápověd. Popisuje vyškeré kroky, které jsou potřebné k vytvoření a vydání nápovědy. |
3030

31+
## Vydávání verzí
32+
33+
- Verze se vydávají nepravidelně
34+
- Číslem verze je vždy datum daného vydání ve formátu rokměsícden (například: 20250621)
35+
- Pokud se v daný den vydá více verzí, pak první má formát rokměsícden a každá další má příponu **-číslo** od 1 s krokem 1, tedy například: 20250606-1, 20250606-2
36+
- Data pro popis změn verzí se získávají z **CHANGELOG.md** v kořeni repozitáře. Popis pro nejnovější verzi se připojuje vždy na začátek souboru. Nejstarší verze bývají ve výpisu nejníže. Poslední sekci s "**File introduced**" neměňte a neodebírejte - slouží i pro Vaši informaci
37+
- Tento postup platí jak pro **HelpViewer**, tak i další nástroje a vydávané nápovědy
38+
- Postup je doporučován i pro autory nápověd, přestože mají možnost si tento bod rozhodnout po svém
39+
3140
[HelpViewer]: https://github.com/HelpViewer "HelpViewer"
3241
[RHelpViewer]: https://github.com/HelpViewer/HelpViewer "HelpViewer"
3342
[RTranslations]: https://github.com/HelpViewer/Translations "Překlady"

0 commit comments

Comments
 (0)