print
Course Name
Creating Outstanding Online Help: A Self-Directed Study (Software Industry)

Contact Hours: 24

Course Description
The major assignment is to create a detailed online help system outline and submit a mini-essay about WHY a specific approach was chosen. It is assumed the student is experienced using browsers and Microsoft Office (namely, MS Word).

Outcome
  • The student demonstrates his or her understanding of what good online help is by recognizing the need for, and demonstrating, upfront analysis.
  • By performing a “Needs Analysis” the student will determine the goals and audience of the help system and the approach to take.
  • The student will submit a final help system outline for assessment in the following areas: usefulness based on user and business needs, overall organization, and clarity of tasks.
  • This course mirrors the work of Technical Writing; it is about continuous improvement and analysis, not “correct” answers. The student’s final grade will be based on their ability to demonstrate toward continuous analysis and improvement.

Assessment
This course is unique in that the student decides which areas they want to focus on; the instructor acts as an experienced mentor. This course is not meant to provide instruction about any online help creation software. The student’s final grade will be based on their ability to demonstrate toward continuous analysis and improvement.

Outline
  1. Introduction The basic structure and principals of online help are discussed. It is assumed that the student has knowledge of main principals and practices of technical writing and online help. The student and instructor create a self-directed course together based on student needs and what they are looking to achieve upon completion of the course. Students choose an existing manual or piece of content they feel is suitable for converting to online help. They will begin the outline by performing a needs analysis: Who, What, Where, When, Why? A report detailing their findings is submitted to the instructor.
  2. Building an Outline The next step is beginning the process of building a solid outline. Students will begin the self-study process by dissecting their study piece (manual, specific content) into applicable "chunks" of information relevant to the organization of online help. Students submit their work to the instructor.
  3. Going Solo – With a Little Help - Weeks 3,4,5 The next step is to begin the outline creation process. During this week, we will review ideas around what constitutes a good outline (and a good help system!), how to set one up, and things to keep in mind. Students work from a basic template that encompasses styles and format given to them by the instructor. Students will spend the next few weeks creating and revising their outline to include: a table of online contents, topics (including plans for content organization, including linking) and basic index structure. Each week a new revision is submitted to the instructor for assessment.
  4. The Revising Process The student spends this week revising (and revising again!) their outline, with their focus being the creation of a solid table of online contents, comprehensive topic lists (and associated content) and plans for indexes. Yet another revision is submitted for analysis with the instructor.
  5. Final Submission Wrap Up The student submits their final outline for grading by the instructor.
  6. Tricks of the Trade The outline is returned to the student noting areas of praise and those requiring further improvement. The instructor shares with the student some tips for creating effective online help.