DQTI读书笔记7-撰写易懂的文档

Posted by Shiwei Shang on June 27, 2025

撰写易懂的文档

想要让文档易懂,要做到以下几点:

  • 表达清楚。避免使用:
    • 词组,能用单词尽量用单词,尽量简练
    • 模糊的表达,比如kinds of
    • 加强语气的词,比如significantly
    • 长句
    • 没必要的修饰词
    • 空洞的段落
  • 避免歧义。要做到:
    • 避免用多义词
    • 指代要明确
    • 修饰词的位置要得当
    • 避免一长串名词定语或者由多个名词组成的名词词组
    • 避免双重或多重否定,如not unlike
    • 不要使用省略
  • 表达连贯。要把同类信息放在一块,按照认知逻辑或者操作流程组织文字,不能把同类的信息散落到各处。
  • 列表的格式要统一;表格的内容要与表头相对应。
  • 只有必要的时候才使用术语,且术语第一次出现时要提供解释。
  • 表达要具体。可以采用:
    • 例子和情境 -比喻和类比
    • 具体的词语
    • 图片
  • 遵循风格手册的规定。这些规定可能包含:
    • 语法
    • 拼写
    • 标点
    • 语气
    • 其他