Re: spec writing - is simple ever wrong ?

Subject: Re: spec writing - is simple ever wrong ?
From: Lois Patterson <loisrpatterson -at- gmail -dot- com>
To: Tony Chung <tonyc -at- tonychung -dot- ca>, techwr-l -at- lists -dot- techwr-l -dot- com
Date: Tue, 30 Jul 2013 22:04:07 -0700

In this case, it sounds reasonable to remove that stilted language. But I
have seen cases where inexperienced writers want to remove
industry-specific jargon and replace it with non-specific "simple" language
that does not actually have the same meaning.

Lois Patterson


On Tue, Jul 30, 2013 at 5:18 PM, Tony Chung <tonyc -at- tonychung -dot- ca> wrote:

> On Tuesday, July 30, 2013, Monique Semp wrote:
>
> > I’m editing a specification, and I was merrily redlining all sorts of
> > convoluted wording to be simple and straight-forward.
>
>
> It could have something to do with groups wanting to defer liability onto
> another party. So when something bad happens each can blame the other for
> not properly interpreting, or writing, the spec.
>
> And most specs are temporary documents that are used to convince management
> to build whatever is specified. Then all the work goes into the detailed
> design documents and nobody refers to the spec again.
>
> -Tony
>
>
> --
> Email: tonyc -at- tonychung -dot- ca
> Phone: +1-604-710-5164
> Web: http://tonychung.ca
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> New! Doc-to-Help 2013 features the industry's first HTML5 editor for
> authoring.
>
> Learn more: http://bit.ly/ZeOZeQ
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as loisrpatterson -at- gmail -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
>


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.

Learn more: http://bit.ly/ZeOZeQ

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

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


References:
spec writing - is simple ever wrong ?: From: Monique Semp
Re: spec writing - is simple ever wrong ?: From: Tony Chung

Previous by Author: No One Reads (Was: [External] Re: SharePoint question)
Next by Author: RE: Taking active vs. passive voice too far
Previous by Thread: Re: spec writing - is simple ever wrong ?
Next by Thread: Re: spec writing - is simple ever wrong ?


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

Sponsored Ads


Sponsored Ads