客观礼貌

技术文档中应保持客观礼貌的语气,这样最容易拉近与读者的距离。具体要求有:

  • 客观地传达技术信息,而不是在推销产品,否则易引起读者反感。

  • 保持一种友好礼貌的语气,不要显得强硬粗鲁。

  • 文档中不要穿插太多玩笑,偶尔滑稽一次是可取的,这样能适当展现作者和公司的个性,使人印象深刻。但必须记住,技术文档的首要目的是向读者传达技术信息,不能为了追求轻松愉快的文档风格而使读者不明所以。

案例

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