Re: Style Guide for documenting a Web product

Subject: Re: Style Guide for documenting a Web product
From: Jean Hollis Weber <jean -at- jeanweber -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 14 Feb 2003 15:58:58 +1000

Peter Swisher wrote,

Is there a good style guide for documenting Web-based systems?

The basic question is:
Is a "drop-down list box" on a PC-based app, called the same thing on a
Web-based app?

I agree with Rob Wishey, who said in response,
In the past I have documented web based browser applications by assuming
they are a GUI like any other GUI you normally have to document.

BUT... who are your audience? Is that long-winded phrase "drop-down list box" necessary or appropriate for them? I would just call it a "list." Will your audience be confused if you use a simple term, not a GUI-design term?

Regards, Jean
Jean Hollis Weber
jean -at- jeanweber -dot- com
The Technical Editors' Eyrie


Buy or upgrade to RoboHelp X3 today and receive the WebHelp
Merge Module for FREE ($299 value). RoboHelp X3's all-new
features include conditional text, completely re-engineered
printed documentation output, Context-sensitive Help Toolkit,
single-source layouts, and more!
Order online today at

You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.

Previous by Author: Word2000 vs Word2002 Tracking Changes
Next by Author: Re: Writing for the Open Source Community
Previous by Thread: RE: Style Guide for documenting a Web product
Next by Thread: RE: Basic Voice ??s: OK for Software to "allow", "let", "enable", --- "pr ovide" and so forth?

What this post helpful? Share it with friends and colleagues:

Sponsored Ads