写作风格指南#

遵循这些指南以提交或编辑 conda-build 文档。

受众#

确定您的受众是谁、他们的技能水平以及他们如何使用这些信息。

技术语言#

使技术语言的水平与受众的熟练程度相匹配。低估读者知识总比高估好。将技术术语限制在用户会遇到的那些。如果您必须定义大量术语,请使用词汇表来补充文本中的定义。

如何称呼用户#

使用主动语态(例如“点击这里”)并直接称呼用户(使用“您”而不是“用户”)。在解释动作时,使用动词的“命令”形式:“从菜单中选择一个选项并按 Enter 键。”

格式#

有关格式,请参阅教程模板。提供描述性的任务和子任务标题,并且不要对标题编号。