在复杂的技术研发领域尤其重要的是,在展示和操作概念里嵌入软件的时候,程序员不需要再自己去解读。因此,一份清晰而详细的说明文档是一个没有错误的软件的重要组成部分。

我们的工作范围及内容

编程需要的组成部分会被尽可能详细地说明,如果需要会做特殊标注。其中描述整体系统的总体纲领(基本操作概念)尤其重要。这个部分是设计具体内容的基石。

  • 说明包括例如描述了与系统相关的、可重复操作的行为的黄金准则
  • 描述所有系统元素(控件包)并具体定义他们功能的图形用户界面目录也是系统说明的一个重要组成部分。
  • 定义功能操作流程的部分,如汽车信息娱乐系统的导航功能,也是对操作说明有决定意义的组成部分。
  • 同样的,不同的交互可能性,即所谓的操作模式,也需要在使用说明中进行定义和描述。例如说明操作界面是触屏、远程控制、还是语音控制是非常重要的。
  • 还有一个非常重要的准则 -说明的表述需要让用户觉得通俗易懂。这一点决定了一份使用说明是否能够清楚地解释系统的内容。这也为系统的国际化奠定了基础。

我们的工具

原则上使用说明可以通过不同的工具、运用不同的方式进行设计。我们主要使用基于UML的叙述图(例如MS Visio)、可点击的操作模型(例如Axure RP)、或者是文字说明(Word文档、Excel表格、ODP(基于JAVA))这些工具和方式。