通俗易懂¶
技术文档中不推荐使用只有特定人群才了解的语词。具体要求有:
不推荐使用行话黑话、俚语、脏话等,比如“魔改”(即做特殊的优化)、“CPU 打到 60%”(即 CPU 使用率为 60%)等行话黑话
不推荐使用网络流行语,比如“墙裂”、“童鞋们”等流行语中故意的谐音错别字
案例¶
案例一:
【错误】“欢迎各位 TW 们补充你身边的案例。”
【正确】“欢迎各位文档工作者补充你身边的案例。”
【解释】TW 是 Tech Writer 的意思,意为(技术)文档工程师。这是技术写作领域的从业者才知道的缩略语,为了让更广泛的受众理解,建议修改。
欢迎各位补充你身边的案例。