文档编写指引

以下是我们自己总结出来的通用规范，非行业标准。对外部人员来说，仅供参考，一切以最终你的习惯为准。

每一段文字的结束，不管最后一个词是英文还是中文，都要有中文全角的标点符号，例如逗号 , 句号 。 冒号 ： 等等）。有一个特殊，就是末尾若是链接，为了方便阅读，可以省略标点符号。

这是一段话介绍的是 MySQL。

这是我们官网：http://www.yitasoft.com
中英混排，在英文两边加空格。若句末是英文，则右边不用加空格。

这里是一段有 English 的话。

这里是一段话有 English。
加粗的文字，在前后追加空格，排版更美观且提高可读性。
专有的英文名词可在第一次出现时，用行内代码高亮突出显示。后续重复出现时，为了方便可以省去高亮。

GitLab 是个很好的持续集成工具，以下是 GitLab 的功能列表。
每段话空一个空行，防止一些 Markdown 工具不根据 /n 来换行。
不要在句末用两个空格来换行，很容易在编辑中误删导致转 UI 显示后的格式不如预期。

文档更新指引