DocumentCode :
1738725
Title :
Creating single-sourced tutorials
Author :
Stieren, Carl
Author_Institution :
OmniMark Technol. Corp., Ottawa, Ont., Canada
fYear :
2000
fDate :
2000
Firstpage :
343
Lastpage :
351
Abstract :
Suppose you want to integrate a tutorial, or several tutorials, into your product documentation. Doing so can let your users check their understanding and ability to use what they have learned. In HTML documentation, for example, you could structure your pre-exam documentation so that it builds toward a core set of principles and procedures that you identify as necessary for a typical user. At OmniMark, we had two pieces to this puzzle, but they had not been integrated. We had our HTML documentation for our product, SureSpeed, and the tool to build this documentation, an OmniMark program called kbook2html. We also had a program called examcgi that built online tutorials. To integrate them, I built kexam, a documentation builder written in OmniMark that produces both the HTML documentation, and a set of exams that are templates for a the CGI program, examcgi. To the user, it is all one
Keywords :
hypermedia markup languages; system documentation; technical presentation; CGI program; HTML documentation; OmniMark; SureSpeed; documentation builder; examcgi; kbook2html; kexam; online tutorials; product documentation; single-sourced tutorial development; Documentation; Feedback; HTML; Linux; Programming profession; Teamwork; Testing; Tutorial; Web server; XML;
fLanguage :
English
Publisher :
ieee
Conference_Titel :
Professional Communication Conference, 2000. Proceedings of 2000 Joint IEEE International and 18th Annual Conference on Computer Documentation (IPCC/SIGDOC 2000)
Conference_Location :
Cambridge, MA
Print_ISBN :
0-7803-6431-7
Type :
conf
DOI :
10.1109/IPCC.2000.887292
Filename :
887292
Link To Document :
بازگشت