DSE 1.0.1
README del Centro de Ayuda
Bienvenido al Centro de Ayuda de DSE. Este tema explica cómo está organizado el sistema de ayuda en Markdown dentro de la aplicación y cómo agregar/actualizar archivos de ayuda traducidos.
Qué es este sistema de ayuda
DSE carga los temas de ayuda desde archivos Markdown ubicados en la carpeta Help junto a la aplicación. Cada idioma tiene su propia carpeta y cada tema usa el mismo nombre de archivo en todos los idiomas.
- Ejemplo de carpeta:
Help/es - Ejemplo de archivo:
help.quickstart.md
Carpetas de idioma compatibles (proyecto actual)
en— Ingléses— Españolfr— Francésru— Rusoar— Árabezh-Hans— Chino (simplificado)
Comportamiento de respaldo (fallback)
Cuando el idioma de la interfaz no tiene un archivo exacto, DSE intenta:
- Carpeta de cultura exacta (por ejemplo
fr-CA, si existe) - Carpeta de idioma de dos letras (
fr) - Inglés (
en)
Cómo agregar o actualizar un tema
- Edite o cree primero el archivo en inglés (por ejemplo
Help/en/help.readme.md) - Agregue el mismo nombre de archivo en las demás carpetas de idioma
- Traduce el contenido manteniendo la misma estructura Markdown
- Si es un tema nuevo visible, agregue el ID del tema en
HelpCenterViewModel._topicIds - Recompile y pruebe el Centro de Ayuda
Guía de redacción
- Comience con un encabezado
#(se usa como título del tema en la lista) - Mantenga secciones cortas y prácticas
- Use listas con viñetas para pasos
- Prefiera nombres y rutas estables para mantener alineadas las traducciones
Consejo
Puede abrir la carpeta de ayuda directamente desde el Centro de Ayuda con el botón Open Folder, editar los archivos Markdown y recompilar.