RE: Principles for proceedure writing

Subject: RE: Principles for proceedure writing
From: John Posada <JPosada -at- book -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 8 Apr 2003 16:04:27 -0400


For everything I write, I write for a particular reader; his name is Igor,
he's been with the company for a week, he's on third shift with nobody to
talk to but the documents. If it isn't explained in the documentation, a
supv gets a 4am wakeup call.

John Posada


------------
non-technical. I have it taped to my monitor. Robert Louis Stevenson said
it:

"Write so that you cannot possibly be misunderstood."

I try to put myself in the place of the reader and write from their
perspective. I assume that the reader is a reasonably well-educated person
but not an expert in the current subject matter. Therefore I try to explain

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Purchase RoboHelp X3 in April and receive a $100 mail-in
rebate, plus FREE RoboScreenCapture and WebHelp Merge Module.
Order here: http://www.ehelp.com/products/robohelp/


Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at http://www.raycomm.com/techwhirl/special/contests/
Happy birthday to you, happy birthday to you, happy birthday TECHWR-L....

---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.



Follow-Ups:

Previous by Author: RE: IX-nay (was RE: About Responsibility and Fault)
Next by Author: Documentation Sanity Check
Previous by Thread: RE: Principles for proceedure writing
Next by Thread: RE: Principles for proceedure writing


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

Sponsored Ads


Sponsored Ads