对话式

技术文档中应使用对话式的、平易近人的语气。由于技术文档传达的技术信息本身已经较为枯燥难懂,因此不建议使用过于正式、无聊乏味的语气。

使用对话式的语气并不意味着完全用日常说话的方式来写文档。一般而言,口语存在冗长啰嗦、缺乏逻辑性的倾向,在编写技术文档时应极力避免该问题。

案例

欢迎各位 TW 们补充你身边的案例。