文档编写规范(草稿 v1)
为减少在非技术层面的纠纷与重复修改,特制定此规范,并将在后续不断完善和补充。
一般规则
- 所有英文计量单位及公式应使用
进行渲染。 - 列举对象的属性时,请使用列表而非表格格式。
- 列举属性时,带有类型的属性应以加粗文本加行内代码块标签呈现。
- 在非列举情况下引用属性值时,应使用行内代码块进行渲染。
避免使用的表述
请避免使用以下词语和短语,并替换为推荐用语:
- “代表 (means)” -> “表示”(“不代表”可保留)。
- “保证 (ensure)” -> “确保”(“不保证”可保留)。
- “决定 (determine)” -> “确定”。
- “并不 (stress)” -> “不”。
- “此 (this)” -> “该”。
- “起始 (start/initial)” -> “开始/初始”。
- “累积 (accumulate)” -> “累计”。