DSE 1.0.1
帮助中心 README
欢迎使用 DSE 帮助中心。本主题说明应用内 Markdown 帮助系统的组织方式,以及如何添加/更新多语言帮助文件。
这个帮助系统是什么
DSE 会从应用旁边 Help 文件夹中的 Markdown 文件加载帮助主题。每种语言都有自己的文件夹,并且所有语言使用相同的主题文件名。
- 文件夹示例:
Help/zh-Hans - 主题文件示例:
help.quickstart.md
当前项目支持的语言文件夹
en— 英语es— 西班牙语fr— 法语ru— 俄语ar— 阿拉伯语zh-Hans— 简体中文
回退加载规则(Fallback)
如果当前界面语言没有精确匹配的文件,DSE 会按以下顺序尝试:
- 精确区域/文化文件夹(例如存在
fr-CA时) - 两字母语言文件夹(
fr) - 英语(
en)
如何新增或更新主题
- 先创建/更新英文文件(例如
Help/en/help.readme.md) - 在其他语言文件夹中添加相同文件名
- 翻译内容,同时保持相同的 Markdown 结构
- 如果是新的可见主题,请将主题 ID 添加到
HelpCenterViewModel._topicIds - 重新构建并测试帮助中心
编写建议
- 以
#标题开头(应用会把它作为主题列表标题) - 章节尽量简短、实用
- 步骤使用项目符号列表
- 使用稳定的名称和路径,便于多语言保持一致
提示
你可以在帮助中心点击 Open Folder 直接打开帮助目录,编辑 Markdown 文件后重新构建应用。