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.
展开▼
