客观礼貌

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

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

  • 保持一种友好礼貌的语气,不要显得强硬粗鲁。对于指导性文档,保持冷静、客观、简洁的语气。

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

  • 不要使用使用反问句,不要让读者感受被质疑和挑战。

  • 不要轻易使用感叹句。感叹语气可能会让读者感受到被责备,建议仅用于特别强调的场景,例如:读者执行某项操作后,可能永久性地删除数据,需要提供强烈警示。

  • 不要轻易使用“请”、“抱歉”,除非真的对读者造成了困扰。

  • 避免过分亲切的称呼,例如“亲爱的”,建议始终使用“您”或“你”。

案例

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