Creating user manuals for using in collaborative design

Creating user manuals for using in collaborative design
复制标题

创建用于协作设计的用户手册

DOI:
10.1145/257089.257321
复制
发表时间:
1996
期刊:
Conference Companion on Human Factors in Computing Systems
影响因子:
--
通讯作者:
H. Thimbleby
H. Thimbleby
中科院分区:
--
文献类型:
--
作者:
H. Thimbleby

文献摘要

被引文献

相似文献

计算机支持,以保证其文档的正确性(和持续的可编辑性)。严重的事故发生在非常简单的手工手册[1]。我们自己的工作在A320飞行机组操作手册(FCOM)中发现了更多的缺陷。用户手册通常由技术作者在设备设计投入生产后编写。如果手册的审查导致深入了解设计,那就太晚了。同时,如果设计被修改,说明书可能会不准确。本文描述了一种示例语言,用于从正式规范创建准确和完整的手册。我们展示了如何可以用来改善空中客车A320电传操纵飞机的飞行机组人员操作手册的一部分。该技术易于实现,可以推广到其他领域,并有助于并行工程实践,增加工程师,用户和HCI从业者之间的共同点。这里描述的工作建立在早期的努力之上:HyperDoc [8]是一个交互式设备模拟器,可以生成交互式帮助,超文本手册,也支持Mathematica中的复杂设计分析; Manual Writer [9]是一个简单的程序,采用Prolog系统规范并管理技术作者和工程师的并发修订和编辑。
computer support to guarantee the correctness (and continuing editability) of their documentation. Serious accidents have occurred with very simple manuals done by hand [1]. Our own work has found further flaws in the A320 Flight Crew Operating Manual (FCOM). User manuals are usually written by technical authors after the design of the device has been committed for production. If the manual’s review leads to insight into the design, it is too late. Meanwhile, if the design is modified, the manual may be inaccurate. This paper describes an example language for creating accurate and complete manuals from formal specifications. We show how it can be used to improve part of the Flight Crew Operating Manual for the Airbus A320 fly-by-wire airplane. The technique is easy to implement, can be generalised to other domains, and contributes to concurrent engineering practice—increasing common ground between engineers, users and HCI practitioners. PREVIOUS WORK The work described here builds on earlier efforts: HyperDoc [8] is an interactive device simulator that generates interactive assistance, hypertext manuals, and also supports sophisticated design analysis in Mathematica; Manual Writer [9] is a simple program taking Prolog system specifications and managing the technical authors’ and engineers’ concurrent revision and editing.