程序员常刷题这是技术写作101课程的预读,让您快速了解一些基本的技术写作概念。我们将探索所有这些主题,并将您在实际研讨会中学到的知识付诸实践。定义新的或不熟悉的术语在写作或编辑时,学习识别某些或所有目标受众可能不熟悉的术语。如果该术语已经存在,请定义该术语。如果您要介绍许多术语,请考虑提供词汇表。要定义一个新术语,首先要写一个清晰的一句话解释。例如:Frambly是一个排序预处理器,它根据输入数据的组织选择最佳排序算法。请注意,我们将术语加粗;新术语只加粗一次。除了第一句话,好的定义倾向于将新术语与读者可能熟悉的东西进行比较和对比。例如:从概念上讲,Frambly占据了与Foobar相似的细分市场。但是,Frambly会自动在十几种排序算法中进行选择,而Foobar只能在两种算法之间切换。读者喜欢包含示例的定义。
暂无评论