RE: keeping the page count down?

Subject: RE: keeping the page count down?
From: Lynne Wright <Lynne -dot- Wright -at- tiburoninc -dot- com>
To: Debbi Crum <debbi -dot- crum -at- yahoo -dot- com>, "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 2 Oct 2014 17:39:31 +0000

Its almost impossible to comment on what you might do differently, without having some idea/a sample of what you ARE doing.

I mean, if you're explaining a process that takes 15 minutes to do, but your doc is 50 pages long, then, yes, there's probably a problem...

Maybe you're using too many screenshots, and those shots show the whole UI, rather than just showing the relevant action? Are you repeating information again and again? Are you giving more information than the user really needs (i.e. explaining things that the user will see for themselves on-screen, such as the results of actions?) Are you writing succinctly in plain English, or are your sentences overly wordy and complicated -- more like academic writing?

My advice would be to ask a pro technical writer and/or hire a technical editor to review and comment on your work.

-----Original Message-----
From: techwr-l-bounces+lynne -dot- wright=tiburoninc -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+lynne -dot- wright=tiburoninc -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Debbi Crum
Sent: October-02-14 1:19 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: keeping the page count down?

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 Lynne -dot- Wright -at- tiburoninc -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

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


Follow-Ups:

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

Previous by Author: issue with graphics imported into FrameMaker 8
Next by Author: RE: keeping the page count down?
Previous by Thread: 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