Business issues, documentation and editors
In what I do (business end user software documentation) this is answering
the question, "What is this technology and why would someone use it."
They're using it to solve a business problem. In order to highlight the
features/mechanics of the program, you need to understand the business
problem or practice that the user is dealing with.
One of my biggest complaints about a lot of software documentation is that it tells me *how* to do something but doesn't give me a clue *why* I might want to, or what it's for. The assumption seems to be that the reader wants to do X but doesn't know how. I think that's often an incorrect assumption; sometimes it never occurs to me that X was a possibility -- I didn't know enough to even ask the question.
I am reminded of this problem because the people who edit the books I write frequently point out to me that I am guilty of doing the same thing -- making an invalid assumption about what my audience knows. As soon as they point it out, I realise they are correct and I add a few sentences to put the procedure into perspective. In the past I've usually been the editor spotting the missing information; it's quite an eye-opener to be on the other side <grin>.
Jean Hollis Weber
mailto:jean -at- jeanweber -dot- com
The Technical Editors' Eyrie http://www.jeanweber.com/
Attention ForeHelp and Doc-to-Help Users! Upgrade your existing product to RoboHelp for FREE, through January 15th. RoboHelp can import your existing Help projects! Learn how else RoboHelp can benefit you. www.ehelp.com/techwr
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.
- Re: Business issues, documentation and editors, Steven Brown
Re: Client woes: a question to ask yourself...: From: Charles E Vermette
Previous by Author:
Re: Client woes: a question to ask yourself...
Next by Author: Re: Editing Marks - Please Help!!!
Previous by Thread: Re: Client woes: a question to ask yourself...
Next by Thread: Re: Business issues, documentation and editors
Search our Technical Writing Archives & Magazine