Re: keeping the page count down?

Subject: Re: keeping the page count down?
From: Julie Stickler <jstickler -at- gmail -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 2 Oct 2014 14:30:51 -0400

If he's the only person to give you that feedback, and you don't think
you're being verbose, why are you trying to cut your writing? You said
that your document is for office workers, I find that they are often the
most computer-phobic and need the most hand holding when dealing with
software.

You don't have to please every reviewer. Especially reviewers who know the
product well and might think that there is content in your docs that
"everyone knows." I often put content in my doc because *I* didn't know it
and it took me hours to research it, and I figured if it had taken me that
long to track down the answers, any user who hadn't personally coded the
software might also want to know that information and appreciate that I
included it for them.



On Thu, Oct 2, 2014 at 1:18 PM, Debbi Crum <debbi -dot- crum -at- yahoo -dot- com> wrote:

> I just had someone complain "why is the stuff you write always so long?".
> He's the only person who has said this. I don't think it's what I write
> (I'm not that verbose), and I don't go overboard with screen captures.
>
>
> I think it has more to do with the design of the document itself. This is
> a PDF document that explains how to set up cross-references in a
> third-party application, so that our application can query it for data. It
> also briefly describes how to use those query results. The document is
> meant for office workers not developers or IT personnel. The process isn't
> complex. There's just a lot of jumping around between our application and
> the other application and different screens in each.
>
>
> Does anyone have suggestions on how to make a document more compact, so I
> can get the same amount of information in a smaller "package"? Or can you
> give me examples of ones that you think are well done?
>
> Thanks in advance!
>
> Debbi
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Read about how Georgia System Operation Corporation improved teamwork,
> communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as jstickler -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
> http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
>



--
Julie Stickler
http://heratech.wordpress.com/
Blogging about Agile and technical writing

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l

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

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-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


References:
keeping the page count down?: From: Debbi Crum

Previous by Author: Re: Learnin' some git. Was: RE: Is this the future of technical writing?
Next by Author: Re: Is this the future of technical writing?
Previous by Thread: RE: keeping the page count down?
Next by Thread: Re: keeping the page count down?


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

Sponsored Ads


Sponsored Ads