简洁清晰

技术文档中应使用精练的语言。建议作者在完成初稿后再通篇读一遍文档,将文中所有对表达意思没有明显作用的字、词、句删去,在不影响表达效果的前提下把文案长度减到最短。具体要求有:

  • 禁止啰嗦冗长

  • 禁止逻辑混乱

  • 同一文档中勿重复表达同一事物

  • 尽量用主动时态,尤其要阐述清楚主语和宾语

案例

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