RE: Doc Design and Conventions

Subject: RE: Doc Design and Conventions
From: "Combs, Richard" <richard -dot- combs -at- Polycom -dot- com>
To: "Keith Hood" <klhra -at- yahoo -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>, "Robert Lauriston" <robert -at- lauriston -dot- com>
Date: Fri, 30 Oct 2009 17:58:08 -0600

Keith Hood wrote:

> But use cases (usually) are supposed to describe interactions between
a
> human user and the system. If you change any labels on the UI, or if
> you change what type of control the user activates to perform a
> function, you'd have to at least edit the use cases to reflect the
> changes in the control arrangements. That would apply even if the
> functions remain the same.

No, no, no. I don't claim to be an expert on use cases, but I know for
certain that UI labels and controls have no place in them. Those are
implementation details.

A use case describes the user's interactions with the system at a much
higher level. "The user specifies a date range and submits the report
request," not "The user clicks the calendar icon..."


Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richard -dot- combs -at- polycom -dot- com
303-223-5111
------
rgcombs -at- gmail -dot- com
303-777-0436
------




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

Are you looking for one documentation tool that does it all?&#160; 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-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
Re: Doc Design and Conventions: From: Robert Lauriston
Re: Doc Design and Conventions: From: Keith Hood

Previous by Author: RE: suggestions for naming a UI element
Next by Author: RE: tools for writing hierarchical taxonomy? (virtual card sorting)
Previous by Thread: Re: Doc Design and Conventions
Next by Thread: Doc Design and Conventions


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

Sponsored Ads


Sponsored Ads