TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:RE: Style Guide for documenting a Web product From:"Robert Wisbey" <robert-wisbey -at- scitech-consultants -dot- co -dot- uk> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 13 Feb 2003 19:34:38 +0100
Peter,
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.
Also, I guess some web developers may not be able to create a browser
based app that is totally intuitive to use. Hence there may be some
ambiguity as to what functions to perform in what order. This is where
documentation can be of use ;-)
-----Original Message-----
From: bounce-techwr-l-118026 -at- lists -dot- raycomm -dot- com
[mailto:bounce-techwr-l-118026 -at- lists -dot- raycomm -dot- com] On Behalf Of Peter
Swisher
Sent: 13 February 2003 19:13
To: TECHWR-L
Subject: Style Guide for documenting a Web product
Is there a good style guide for documenting Web-based systems? I've
googled this and found a number of style guides for designing Web pages,
but none for documenting Web pages.
IMO, a Web page should be designed such that it doesn't need to be
documented, but unfortunately, that's not the case here.
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 have the MS MOS, but it doesn't address this issue.
Thank you,
Pete
---
Outgoing mail is certified Virus Free.
Checked by AVG anti-virus system (http://www.grisoft.com).
Version: 6.0.454 / Virus Database: 253 - Release Date: 10/02/2003
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 http://www.ehelp.com/techwr-l
---
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 http://www.raycomm.com/techwhirl/ for more resources and info.
