Skip to content

文档格式约定

必要性描述

所有文档中关于必要性描述,遵循 RFC 2119 的定义(阮一峰的翻译版),如下:

必要性等级Tag同义词
必须MUST
禁止MUST NOT
建议SHOULDRECOMMENDED
不建议SHOULD NOTNOT RECOMMENDED
可选MAYOPTIONAL

为提高可读性,文档中使用到必要性描述时,建议 对必要性等级用词进行必要的样式区分,比如加粗

盘古之白

作为前端,对文字排版之类 UI 层的内容,应该有一些必要的追求。建议 参考 中文文案排版指北 的规则,对文档进行基础的排版,以提高可读性

类似的规范: