4 Study Area CN Learn 用词规范
cxykevin edited this page 2024-08-30 23:28:32 +08:00
This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

虽然这是一个社区项目,但是必要的用词规范和一些格式要求是必须的,以下是一些用词&格式规范:

  1. 不要出现类似“十分好的”这种不通顺的语句,比如在这个例子中我们应该修改为“十分优秀”。
  2. 不要使用不常用的缩写比如“VMWW”因为这样的缩写令人难以理解在这个例子中应修改为“VMware Workstation Pro”。
  3. 无论在什么情况下,都不要使用拼音缩写。
  4. 每句话后必须有合适的标点符号结尾,标点符号统一使用中国大陆格式的全角标点,参考GB/T 15834-2011 标点符号用法
  5. “and”、“和”等表示两者和的词语可以被简写成“&”。
  6. 引用块有多种用途,可以当作引用、注释、页尾使用。
  7. 文中难以理解的段落要在该段落所属的块之下使用引用块进行解释,不要把它留到最后解释!
  8. 难以理解的词语可以使用“[序号]”的格式进行注释,注释的详细内容统一在该章节的最后解释。
  9. 引用一篇外部文章的时候,要注意遵守源许可证的规定。
  10. 当文章中出现非中国大陆标准的异体字,如果无特殊需求(例如来自中国台湾的人名)请使用标准的简体中文格式。
  11. 不必须请勿剧透内容!!!!!
  12. 行内代码块应用于所有简单的命令行、参数、键盘按键、代码等处,并前后与文段有空格分割(如果前后有任何标点符号不应添加空格)。
  13. 所有的英文内容前后均需要有空格(前后有标点符号则忽略)
  14. 多行代码块可以被用于命令输出,所有的文本统一使用 text 类型,所有的 Shell 脚本统一使用 bash 类型并开头不能以 $ # 等无关命令本身的内容出现(变量等除外)