Hyperviews Online

Anne Gentle has provided a list of wikis she has found that are used for product documentation or to provide new and updates about software products.

by Guy Ball, Senior STC member, Orange County (CA) Chapter
Reprinted from the December 2006 issue of TechniScribe. If you reprint this in your publication, please send a PDF copy or link to the author.

While text is still best for presenting many types of reference and procedural information, video can be very effective when illustrating product features, clarifying system configurations, and supplementing complex written procedures. The trick is to merge the two so they complement each other and deliver a dynamic documentation package as either an online or CD-based “Web seminar.”

Although the multimedia concept has been around for some time, creating a seminar like this traditionally requires a good-sized team of writers, videographers, graphic artists, subject matter experts (SME), and a manager, to keep the team working smoothly. If you already have a large staff or access to graphic professionals, congratulations!

Our staffing situation is totally the opposite. We have to make do with a single writer and a few subject matter experts (SMEs). The plus of this situation is that it allows us to deliver the final product faster and less expensively—both important considerations for our cost-conscious management.

We take advantage of our low-cost (but high-quality) video camera and simplified video-editing software to deliver additional “visual documentation” to our service support team and customers. For us the trick is to look “clean” and professional while not getting caught producing a Hollywood extravaganza that would demand tons of staff time and weeks of extra work with little extra benefit. Instead of “fancy,” we make sure our content and delivery is effective both from communications and cost perspectives. (more…)

An overview of XHTML for mobile devices is available: http://www.littlespringsdesign.com/design/xhtmlinfo/ The site has a variety of other resources on mobile devices also,

http://www.horton.com/html/elexampleslist.aspx?ExampleID=13

http://www.elearningguild.com (journal articles, members only)

http://www.alleni.com (case studies and demos; register for the demos)

WritersUA has published its 2006 Skills and Technologies Survey results.

by Marcia Poulsen, member, Central New York chapter and Online SIG

The feedback I’ve received on my presentation, originally posted on this site Aug. 5, has inspired me to revise it. The updated version is entitled “The Three Core Topic Types: Concept, Task, Reference” (PPT, 4.5 MB).

Thanks to all who contributed thoughts.

by Marcia Poulsen, member, CNY chapter and Online SIG

Should writers use gerunds in topic titles, for example, “Balancing the Checkbook”?

There’s been some excellent, thought-provoking discussion on STC’s Online SIG list on this question recently. It’s a question that I’ve wrestled with for a while, not just for online Help but for topic-based writing in any medium. I’ve read everything I could get my hands on about topic-based (modular) writing, I’ve studied examples of online Help, and I’ve debated this question with anyone who’s interested.

Here’s what I’ve found. (more…)

The older issues of “Hyperviews Online” occasionally addressed electronic performance support, and scanning through them shows that the STC Annual Conference has had presentations on this topic over the years. STC members can search past conference proceedings. Session materials from past conferences are also available. Search for “session materials” on the STC website. Other useful resources include:

“Key concepts in electronic performance support” on ESSS Central. Also, archive site. Links current August 2005.

“Make Way for Interactive Assistance” by Craig Marion. Published May 1, 2000. Link current May 2005.

We have a resource list on the subject of embedded help, and are moving it from our old website to this one to make it more visible. The list follows and includes one article by the Online SIG. (more…)

The April, 2006 issue of the newsletter of the STC UK Chapter has been posted at:
http://www.stcuk.org/newsletters/April2006/index.htm

“Tools, Tips, and Websites,” starting with Content Management Strategies, focus on several aspects of online communication. Desktop search, MS Word’s RD field code, and capturing an image from Windows Media Player are included, along with content management and Online Help.

The Online SIG knows of two comprehensive sites on online Help. Do you know of others? Please leave a comment.

MSHelpWiki. Initially created by the Microsoft Help MVPs and maintained by the Help authoring community. (January 2006)

Helpstuff by Char James-Tanny. (April 2006)

The Online SIG also has a list of references on Online Help.

The MSHelpWiki has a list of currently available Help authoring systems.

Char James-Tanny published an updated “Help Authoring Tools Comparison Matrix” in February 2006.

Key facts about commonly used tools follow. (more…)

The Online SIG has compiled fact sheets on Online Help, with significant input from Online Help Lead Char-James Tanny and SIG founder Scott DeLoach. This fact sheet has basic information on formats, for people who are new to Online Help or a particular format, or do not use a particular Help format very often. There are three primary Help formats. (more…)