【短视频教程】技术写作中的常见错误(1)
本视频主要介绍技术写作中的常见错误,以及如何来规避这些错误。本部分主题视频将分为三期发布,请持续关注。
技术写作中的常见问题不仅仅容易出现在新手文档工程师身上,即使是经验丰富的老手也很难完美避开这些问题。让我们来看看Janne在本期视频中提到了哪些问题:
信息表达不一致,即使用不同的描述来表达同一件事物,这很容易造成用户误解甚至投诉。
信息冗余,即信息多余或重复出现。如果文档中出现大量的信息冗余,可能会造成文档篇幅过长,用户读起来费时等问题。
信息呈现形式过于单一,仅局限于文字表达。信息的载体不应该只有文字,比如当图片比大段文字更具有说服力的时候,请果断使用图片。
过多使用被动语态。被动语态会隐藏句子的主语,即动作的发出者,这很容易使英语非母语用户感到疑惑:这个动作是需要我来完成吗?所以请尽量多使用主动语态,来直接明确地表达动作的发出者。
(本视频约10分钟,建议WIFI环境下观看)
文章转载自微信公众号科多思技术传播社区
声明:本站所有文章资源内容,如无特殊说明或标注,均为采集网络资源。如若本站内容侵犯了原著者的合法权益,可联系本站删除。