BakaXL 启动器用户文档

BakaXL 帮助文档编写规范

本篇主要讲解如何编写 BakaXL 帮助文档。

BakaXL 版本

如果您想获取 BakaXL 的正式版或您收不到 (不确认) BakaXL 测试版的推送通知您可以前往 BakaXL Jenkinsopen in new window 的构建页面获取最新版 BakaXL。

其中 BakaXL Insider Parrot 是鹦鹉通道，也是最新推送的 3.0 版本，而 BakaXL Sloth 是正式版通道，稳定版的推送通道，选择构建号最新的版本进行下载即可。

在未来 BakaXL Insider Bunny 会启用，该通道适用于 BakaXL 4.0 预览版本，在 4.0 测试版上线通知前，我们的帮助文档仅限于 3.0 版本，当然我们会预留 4.0 的文档路径。

BakaXL LTS 2.x 版本已宣布停用并且不给予更新支持，因此帮助文档应当去引导用户使用 3.0 版本，我们也不提供 2.x 的解决方案。

文本格式

  • 中英文、中英文符号、数字空格：

在英文单词/数字与文字之间保留空格作为间距，在代码块之间也使用空格作为间距。

正确示范：BakaXL 是新一代 Minecraft: Java Editon 启动器，具有众多功能，现已支持 Windows 7 以上系统。
错误示范：BakaXL是新一代Minecraft:Java Editon启动器，具有众多功能，现已支持Windows7以上系统。
  • 专有名词大小写：
正确示范：BakaXL、Minecraft
错误示范：bakaxl、minecraft
  • 统一使用 / 作为或的替代符号与路径符号；
  • 在进行部分内容的英译中时请参考 标准译名 而不是使用机器翻译；
  • 括号优先使用 半角符号 (在英文输入法下打出的符号)；
  • 规范使用不同标题大小；
    • 在所有文档中请使用 # 标题 作为该文档的主标题，该标题不得有第二个，使用 ## 标题 作为问题标题，使用标题请务必按照层级使用，不得跨级，否则会导致侧边栏不渲染目录！
  • 禁止随意使用 HTML 来渲染文档！ Markdown 支持通过 HTML 在获得一些特殊的效果，但是除非必要请勿使用 HTML 作为语法。

排版提示

在进行编写时，请务必参考该项目：中文文案排版指北 - GitHubopen in new window

改善观感

  1. 不要大量的使用加粗字体；
  2. 不玩梗；
  3. 不使用不文明用语；
  4. 使用标题时，请用标题；不使用粗体字代替标题；
  5. 标题等级分明，不随意使用跨等级标题；
  6. 在用词方面注意语法以及语意，避免产生歧义，不应出现地域性词语与方言。

以上行为均会导致文档十分瞎眼或观感极差，所以绝对不要这样干 <这就是例子

使用分割线

尽量避免使用分割线，分割线会给文档内容带来割裂感，在你需要的时候才应该这么做。

在一般的 Markdown 文档编写中不需要用到分割线，更不要随意使用分割线，所有标题会自带分割线。

截图 / 被相对调用的资源

  • BakaXL 截图请使用默认窗口大小，不要随意改变窗口大小；
  • 上传截图前确保图片能够找准重点而不是将重点藏在小角落；
  • 为缩减仓库体积，图片推荐上传至 pic.onmicrosoft.cnopen in new window 或其他你觉得可信的图床；
  • 请及时在仓库 Docs-assets(https://github.com/BakaXL-Support/Docs-assets) 保留一份存档以防未来图床跑路或其它情况；
  • 相对路径的引用方式请务必使用 ./ 而不是 /。使用 / 会导致构建时崩溃；
  • 被调用资源名称请使用小驼峰命名法。

小驼峰命名法：名称首个开头单词全小写，后面的单词首字母大写。

外链

  • 外链必须是可信来源，如果是资料引用请使用已获得官方证实的资料；
  • 如果外链有大量广告 / 误导内容请在文档中使用截图指明。

新建文档

  • 新建立的文档命名务必符合大驼峰命名法。

大驼峰命名法: 所有单词首字母大写。

注意

如果你不知道如何命名，请在群内询问 / 参考其它文件命名方法。

规则之外的情况

maindocs.md 文件属于例外，其中 assets/img 便是 maindocs.md 的资源文件存放文件夹。

提交方法

请先 Fork 本仓库，而后在您的仓库内进行更改，更改完成后 Pull request 至 main 分支 (如果修改了构建代码请选择 dev 分支)，这是所有人的更新规范，包括创建者也是使用这种方法更新文档资料，这样能够避免很多冲突。

  • 如果在 Pull request 后显示出现了冲突 (conflict) 但是您不会解决的话请联系我们，我们会为您处理冲突问题。

您可以查看我们的 Wikiopen in new window 来获得一些其它帮助。