Skip to content

用户手册编写要求

编写内容

  • 完整性
  • 一致性
  • 准确性
  • 统一性

编写风格

  • 描述规范准确,在描述内容、说明方法、提出见解时都应准确无误,恰如其分。用词应标准、统一、规范。
  • 尽可能将信息制成表格,表格可改善信息的可读性。在需要根据不同的基础描述对象,或在不同的维度间比较对象时,可应用表格。
  • 通俗易懂,尽量不使用较深奥的计算机术语,如果不可避免,应该给予适当的解释和说明。
  • 层次分明,每节的内容必须明确,这样用户可以通过目录很方便地查到自己所需要的内容;注意段的划分,每段不要太长,突出重点,否则用户不容易获得其中的精华。
  • 前后一致,在文档中使用的概念、术语的用词要前后保持一致。