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: Web publication style From:Robert Lauriston <robert -at- lauriston -dot- com> To:Robert Courtney <bobsc1 -at- earthlink -dot- net> Date:Thu, 29 Oct 2009 11:17:16 -0700
I think the best practice is to avoid referring to UI components and
just say "click."
I recently wrote a guide to a customized version of Oracle
iProcurement and the only UI elements I referred to were tabs, as in
"Click Home > US Procurement User > Shop tab > Non-Catalog Request."
Once in a while when the UI was particularly challenging I used
phrases such as "in the top right corner."
On Thu, Oct 29, 2009 at 9:21 AM, Robert Courtney <bobsc1 -at- earthlink -dot- net> wrote:
> I have a question about web publication styles. I am looking for
> terminology for describing web applications and the windows they reside.
> Such as the Manual of Style from Microsoft. There they describe all the
> things you need to write about. What the window looks like and what each
> area of the window is called.
> Such as the left navigation tree on the window and the right being the
> main display window. Is there a correct, acceptable name for these
> areas? What are the items in the navigation tree called? ...
Are you looking for one documentation tool that does it all?  Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at: http://www.doctohelp.com/
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-