Help File System for Software Component Workbench

Index:

Abstract
Calendar
Project Development
Findings and Contributions
Links and References

Abstract:

I am currently working with the RSRG team creating a system of help files to be used in conjunction with the new Software Component Workbench (SCW). The SCW is a new software teaching tool that will be used in the introductory sequence (221-222-321). More information on the SCW can be found here.

A preliminary version of the help system was created using HTML files and the java help tool. Since I am graduating this quarter, upgrades are on hold.

Calendar:

I have met with Paolo, Bruce Weide, and Tim Long throughout Autumn quarter discussing the help system structure, semantics, information to be included in the help system vs. a classroom companion, and other issues.

Project Development:

This project started as a HTML project that would provide students with a basic overview of the SCW tool, including some of the reasoning behind the development and use of the tool vs. other approaches, as well as step-by-step methods for accomplishing common tasks. After some attempts to cover both of these objectives, it became clear that the attempt to provide a clear overview and reasoning behind the tool was out of the scope of a true help file system, as well as out of the scope of my personal understanding of the tool and its development.

After meeting with Paolo, Bruce, and Tim, a decision was reached to focus my efforts on developing a beginner-friendly guide to completing specific tasks that the students will be expected to perform in classroom assignments. It was decided that the SCW tool as a whole will be introduced and explained to the students in the classroom using a method still to be determined.

Plans are to build the system using HTML files which can then be linked together using a Java help tool, as the SCW is written primarily in Java.

3/03: A preliminary version of the help system was created using the java help tool, which combines HTML, XML, and java files. It provides basic search and browse functions and can be bundled with the SCW since it is java-based.

Findings and Contributions:

Links and References:

Please see links within the text above.