[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Re: Single Spacing, Double Spacing, and Doing It Ones Own Way

Subject: Re: Re: Single Spacing, Double Spacing, and Doing It Ones Own Way
From: Martha J Davidson <editrix -at- nemasys -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 13 May 2004 13:28:48 -0700


At 11:47 AM 5/12/2004 -0700, Bruce Byfield wrote:

Still, I submit that, even in pure tech-writing, if you can add design
expertise and still make your deadlines, then most clients or employers
appreciate the fact that you are going the extra mile for them.

This has been very true for me. I focus more than anything on the structure and content of every manual and help system I create. In my current job and the one just before this, I have been the first (and only) tech writer here, so as I was learning enough of the technology to begin writing, I created templates that I could use to do that writing. Each time I spent only a day or so to create page layouts that I felt would work well to present the information, and at both jobs I heard comments that let me know it made a difference.

In fact, in my performance review a couple months ago, my manager (the CTO and VP of Engineering) mentioned that "not only are our documents well written, but also very good looking." He continued, saying that he always takes time to show prospective clients the documentation "because its thoroughness, organization, and layout really add to the fit and finish of the product."

I'm not saying this to toot my own horn, but to show an example where a bit of up-front attention to document design made a difference.

martha
--
Martha Jane {Kolman | Davidson}
Dances With Words
editrix -at- nemasys -dot- com

"Too many words bring about exhaustion."
--Tao Te Ching, chapter 5 (translated by Sheets/Tovey)



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

SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo
From a single set of Word documents, create online Help and printed
documentation with ComponentOne Doc-To-Help 7 Professional, a new yearly
subscription service offering free updates and upgrades, support, and more.
http://www.doctohelp.com

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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.


References:
Re: Re: Single Spacing, Double Spacing, and Doing It Ones Own Way: From: Bruce Byfield

Previous by Author: re Usability: Serif and Sans-Serif font faces?
Next by Author: life imitates techwr-l
Previous by Thread: Re: Single Spacing, Double Spacing, and Doing It Ones Own Way [VERY LONG]
Next by Thread: RE: RE: Single Spacing, Double Spacing, and Doing It Ones Own Way

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads