RE: Have to know Programming to be able to write about it? -- IT HELPS

Subject: RE: Have to know Programming to be able to write about it? -- IT HELPS
From: John Posada <JPosada -at- book -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 25 Feb 2003 17:32:20 -0500


>through the entire exercise. Consider how an average
>writer would document an address change feature on a
>brokerage Web site. Easy enough, right? You spend time
>reading the spec, you look at some prototypes, you run
>through the process in a QA environment, you write a
>nicely crafted procedure for online help. But in the
>end, the writer-SME knows something you don't...that
>customers making an address change may also need to
>move their money from one state-specific money market

And unless you know the subject, you don't know that you don't know the
subject. You sit there, happy as a clam because it is the most beautiful
document you've ever created with perfect phrasing, and unless someone with
the knowledge takes their precious time to explain what you missed, you
don't know why they just won't read your stuff.

They won't because there is nothing in the doc that they don't already know.

John Posada
Senior Technical Writer
Barnes&Noble.com
jposada -at- book -dot- com
NY: 212-414-6656
Dayton: 732-438-3372
"Alright, nobody move! I've got a dragon here, and I'm not afraid to use it"
---------- Donkey

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


LAST CHANCE for this steal of a deal! Purchase RoboHelp X3 by February 28
and receive $100 mail-in rebate and FREE WebHelp Merge Module ($339 value)!
RoboHelp, the Industry Standard in Help Authoring, has won over 55 industry
awards. For more information please visit: http://www.ehelp.com/techwr-l2.


"RoboHelp X3 is simply remarkable." - George Bell, Techno-Vision Systems


---
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.



Previous by Author: RE: Have to know Programming to be able to write about it? -- NO
Next by Author: RE: Promoting Tech Writing in WhereAmI, USA
Previous by Thread: RE: Have to know Programming to be able to write about it? -- NO
Next by Thread: Writing API Documenation


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


Sponsored Ads