Language guide for writing specifications

Subject: Language guide for writing specifications
From: "Moshe Kruger (AllWrite)" <moshe -dot- kruger -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Sun, 14 Oct 2012 12:23:34 +0200

Hello all,

I am training a group of authors in writing functional and technical
specifications.

Since these documents have commercial impact for the solution provider
and their customer, clear and unambiguous language is critical.

1) Vagueness
I feel they should avoid vague words such as "could", "should", "can"
as in "the system could provide ..." or "the application can calculate
the sum this way or that way".

2) Excessive Legalese
Should authors use "shall" to describe the functions of the future
solution, or is "will" just as good, if not preferable?

Are there members of the forum who can point me to resources that will
help me in compiling a language guide for such documents?

Thanks in advance,


--
Moshe Kruger
Mobile: +972-52-770-7387
---------------------------------------
AllWrite Information Design: www.allwrite-design.com
LinkedIn Profile: www.linkedin.com/in/allwrite

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.

Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.

http://bit.ly/doc-to-help

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

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:

Previous by Author: Re: His/Her v. Their
Next by Author: Re: Re: I love this group
Previous by Thread: TechWhirl: Technical Communication Recap for October 12, 2012
Next by Thread: Re: Language guide for writing specifications


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

Sponsored Ads


Sponsored Ads