文档编写规范

在参与编辑本文档前，请首先阅读以下内容

编写规范

文本与排版规范

排版提示

可参考该项目：中文文案排版指北

• 请使用书面性语言描述，避免口语化表达
• 文章内容规范化
  • 正确使用专有名词大小写
  • 考虑不同受众，不同文章应有不同的详略程度
• 使用中性语言叙述
  • 避免褒贬性的评价
• 格式化文本内容
  • 在中文与英文 / 数字 / 代码块之间使用空格格式化，在段落中间的链接或引号也需要增加空格
  • 正确使用符号，在中文之间使用中文括号，英文之间使用英文括号并带有空格
  • 使用 * 进行加粗，使用 --- 添加分隔线。
  • 所有 Markdown 外链末尾无需添加 / 结尾。
• 按层级规范使用标题，请勿跨层级使用

图片规范

• 为方便中国大陆地区用户访问，请使用在中国大陆地区具有正常连通性的图床
  • 为防止失效，所有资源均应在 docs/assets 中保存一份副本
• 图片宽 / 高均应小于 1024 像素，从而加快加载速度，同时避免出现比例不正常的问题
• 文件名应符合命名规范，并简要描述用途
• 不应含有非默认的外观 / 选项设置，避免产生不必要的误导
• 如一张图片中涉及多个操作，请使用矩形框出各步骤并按先后顺序标注序号

命名规范

• 务必使用大驼峰命名法
  • 所有单词首字母大写
• 对文章命名时应规范化并尽量简短
• 适用于不同启动器的相同内容务必命名相同

如何参与贡献

1. 对本仓库进行 Fork
2. 在您 Fork 后的仓库内进行更改
3. 使用 Pull Request 提交至 main 分支
   • 如果你对构建代码进行了修改，请提交至 dev 分支
   • 在进行 Pull Request 前，你需要同步原仓库内的内容以保证你的仓库保持最新
4. 等待您的 Pull Request 被合并