编写规范

在参与编辑本文档前，请仔细阅读以下内容，以确保您的贡献符合项目标准，避免不必要的修改。

编写提示

本规范主要作为建议性指导原则，所有内容都应符合标准 Markdown 格式。

文本与排版规范

排版参考

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

• 使用大驼峰命名法：所有单词首字母大写
• 文章命名时应不超过三个单词，确保语义清晰
• 正确使用专有名词的标准写法，保证内容一致
• 根据目标读者调整内容的详细程度，确保可读性
• 使用中性、客观的书面语言，避免口语化表达和主观性评价
• 术语使用要准确一致，避免同一概念使用不同表述

格式要求

• 严格区分中英文标点符号，避免混用
• 使用标准的 Markdown 语法，确保渲染效果一致
• 在中文与英文、数字、代码块之间添加适当空格

图片使用规范

• 为方便中国大陆地区用户访问，请使用在中国大陆地区能正常访问的图床
  • 为防止失效，所有资源均应在 docs/assets 目录中保存副本
• 图片尺寸要求：宽高均应小于 1024 像素，文件大小应控制在合理范围内
• 图片命名规范：文件名应标注对应文章序号并简要描述用途，使用英文命名
• 图片内容要求：
  • 不应含有非默认的外观或选项设置，避免产生不必要的误导
  • 如一张图片中涉及多个操作，请使用矩形框出各步骤并按先后顺序标注序号

如何参与贡献

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

注意事项

• 提交前请确保您的修改符合上述规范要求
• 建议在本地预览渲染效果，确保格式正确
• 如有疑问，欢迎在 Issue 中讨论