RE: The GUI shall do...

Subject: RE: The GUI shall do...
From: "Combs, Richard" <richard -dot- combs -at- Polycom -dot- com>
To: "salt -dot- morton -at- gmail -dot- com" <salt -dot- morton -at- gmail -dot- com>, "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 22 Jan 2013 09:52:24 -0800

Chris Morton wrote:

> You're preaching to the choir, Anne. I'm looking for the thread regarding
> this, especially as it pertains to the government backing away from this
> anachronistic standard.
>
> Thx
>
> On Tue, Jan 22, 2013 at 9:30 AM, Anne Robotti <arobotti -at- gmail -dot- com> wrote:
>
> > I personally would fight to the death if anyone tried to make me use it.
> >
> > But that's just me....
> >
> > Anne
> >
> >
> >
> >
> > On Tue, Jan 22, 2013 at 12:25 PM, Chris Morton <salt -dot- morton -at- gmail -dot- com>wrote:
> >
> >> Does anyone remember a thread here sometime last year about the use of
> >> "shall" in documentation (e.g., software GUI specs)?

Audience and purpose, folks ... audience and purpose. For most audiences and purposes, I agree. But for a formal requirements document, you should adhere to the key word usage specs laid out in RFC 2119 (www.ietf.org/rfc/rfc2119.txt). It's not an anachronistic standard, it's a means of avoiding ambiguity.

That said, I'd use MUST and MUST NOT in preference to SHALL and SHALL NOT whenever possible.

Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-903-6372
------






^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
See what's new in Doc-To-Help 2012 in a free webcast:

Read all about them: http://bit.ly/C1-webcast
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-leave -at- lists -dot- techwr-l -dot- com


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

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

References:
The GUI shall do...: From: Chris Morton
Re: The GUI shall do...: From: Anne Robotti
Re: The GUI shall do...: From: Chris Morton

Previous by Author: RE: Log in vs. login
Next by Author: RE: The GUI shall do...
Previous by Thread: RE: The GUI shall do...
Next by Thread: Re: The GUI shall do...


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


Sponsored Ads