DSE 1.0.1
README du Centre d’aide
Bienvenue dans le Centre d’aide DSE. Cette rubrique explique l’organisation du système d’aide Markdown intégré et la façon d’ajouter/mettre à jour les fichiers d’aide traduits.
À quoi sert ce système d’aide
DSE charge les rubriques d’aide depuis des fichiers Markdown stockés dans le dossier Help à côté de l’application. Chaque langue a son propre dossier, et chaque rubrique utilise le même nom de fichier dans toutes les langues.
- Exemple de dossier :
Help/fr - Exemple de fichier :
help.quickstart.md
Dossiers de langues pris en charge (projet actuel)
en— Anglaises— Espagnolfr— Françaisru— Russear— Arabezh-Hans— Chinois (simplifié)
Comportement de repli (fallback)
Si la langue de l’interface n’a pas de fichier exact, DSE essaie :
- Le dossier de culture exact (ex.
fr-CA, s’il existe) - Le dossier de langue à deux lettres (
fr) - L’anglais (
en)
Ajouter ou mettre à jour une rubrique
- Créez/modifiez d’abord le fichier anglais (ex.
Help/en/help.readme.md) - Ajoutez le même nom de fichier dans les autres dossiers de langue
- Traduisez le contenu en conservant la même structure Markdown
- Si c’est une nouvelle rubrique visible, ajoutez l’ID dans
HelpCenterViewModel._topicIds - Recompilez et testez le Centre d’aide
Conseils de rédaction
- Commencez par un titre
#(utilisé comme titre de la rubrique dans la liste) - Gardez des sections courtes et pratiques
- Utilisez des listes à puces pour les étapes
- Préférez des noms et chemins stables pour aligner les traductions
Astuce
Vous pouvez ouvrir le dossier d’aide directement depuis le Centre d’aide via le bouton Open Folder, modifier les fichiers Markdown puis recompiler.