Re: What is"well Written"?

["Damien Braniff" <Damien -dot- Braniff -at- asg -dot- com>]

Dan asked:
Define "well written". 
Define "understandable English"

To me, "well written" is everything that complements technical accuracy
- what makes the document usable. This would include:

	The look/layout, use of white space etc
	Organisation - how the doc is structured etc
	Navigation - how to find that accurate info, toc, index etc

Basically everything/anything that makes it easy to read/use.

Understandable English is part of that as well - good grammar etc. It's
also writing for your audience, using language, jargon etc appropriate
to the reader.

Damien Braniff
Sr. Technical Writer
damienb -at- asg -dot- com

Waterfront Plaza
8, Lagan Bank Road
Belfast, N. Ireland BT1 3LR
Tel: +44 (0) 28.9072.3124
Fax: +44 (0) 28.9072.3324

ASG | www.asg.com

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

Create HTML or Microsoft Word content and convert to Help file formats or 
printed documentation. Features include support for Windows Vista & 2007 
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: 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.