Re: vocabulary for web application docs?

Subject: Re: vocabulary for web application docs?
From: "Lisa Wright" <liwright -at- qwest -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 7 Jun 2001 19:08:22 -0600

Sella,
I have a similar confusion for our web application, and my solution for each audience has been different:

1. Programmers, for whom I am writing the functional specifications: "content area." I don't really like it, but it works for them. My semi-random usage of frame, window, screen, etc., was confusing.

2. End users: "screen." Period.

The general rule in style guides is to eliminate needless knowledge for the end users. For example, don't say "drop-down list," say "list." There are similar guidelines for dialog boxes, which I can't remember off the top of my head. The point is that I DO remember the general rule, and extend it as it makes sense to me. When somebody comes along with something better, I'll evaluate it and see if it makes sense to change.

MTC.

Lisa Wright


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com

Sponsored by Cub Lea, specialist in low-cost outsourced development
and documentation. Overload and time-sensitive jobs at exceptional
rates. Unique free gifts for all visitors to http://www.cublea.com

---
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.


References:
vocabulary for web application docs?: From: SM Rush

Previous by Author: Re: altering delivered documentation
Next by Author: Re: It's Your Call: Which E-mail Disclaimer is Best? (LONG)
Previous by Thread: Re: vocabulary for web application docs?
Next by Thread: Documenting APIs (belatedly)


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


Sponsored Ads