#Conventions and style
##Conventions
-
文档中的代码如非特别说明,均使用C#编写。
-
文档中的脚本如非特别说明,均是在powershell环境中编写。并且powershell环境中安装了最新版本的nodejs、git、Azure PowerShell。
-
统一使用 “推荐” 或者 "Do" 表示推荐使用的模式和实践。
-
统一使用 “避免” 或者 "Don't" 表示要求避免使用做法。
##Style
-
语言保持简洁。不要使用委婉的语气。不要过多解释原因。
-
将实践原则与原因分别写到不同的文档中。如果文档的主要目的是列举模式和实践,只需要进行罗列并且表述清楚即可。每条模式和实践的原因和解释说明,推荐写在另一篇独立的文档说明,然后进行链接即可。
-
段落使用左对齐风格,不要段首空2格。完整使用标点符号。
-
段落、图片、表格、引用之间保留一个空行。
-
技术名称、框架名称、开发平台等通用专有名词使用官方的全称英文单词。不要使用翻译的中文单词,也不要使用缩略语。英文单词前后保留一个空格。
##More resources