RE: One big word document or break apart

["Kathleen" <keamac -at- cox -dot- net>]

There are pros and cons to embedding graphics: the document quickly
increases in size (though I admit in the past docs tended to do so with
referenced files too); you can't update without re-importing. 
When using referenced files, it's true that you need to have your
referenced files included along with the doc if you move it. Yet you
need to have copies of the graphics even if you are embedding, and I
always found it most efficient to keep them in a subfolder of the
document folder. That way I didn't run into too many naming problems
(e.g., screen captures were named in a generic fashion). If there's a
better way to store and track graphic files, I'd be very interested in
learning it :-)

Kathleen

-----Original Message-----
From:  Dan Goldstein
Sent: Wednesday, June 29, 2005 6:23 AM
To: TECHWR-L
Subject: RE: One big word document or break apart


Hi Daniel,

The answer depends not on the mechanics of Word but on your readers'
needs.

If contributors, reviewers, or users are interested only in specific
sections of the large document, it makes sense to break it up.

Otherwise, a single, 300-page document with a screen capture on each
page is very manageable in Word 2003. A few recommendations:

* Make sure you have 1 GB of RAM.
* Make sure you have SnagIt. (300 screen captures!)
* Save your screen captures in PNG format.
* Use anchored (not floating) graphics.
* Open and edit the document locally, not over a network.
* Someone recommended referenced (aka linked) screen shots. Use these
only in a controlled environment, e.g. if you prepare the whole thing in
Word and then convert to PDF for printing. If you're going to send it
anywhere as a Word document, go for embedded graphics.

By the way, kudos on enforcing Word styles!

-- Dan Goldstein

> -----Original Message-----
> From: Daniel Ng
> One of my upcoming projects. We have one single 300 page Word 
> document. Each page contains a dialog screenshot, and every field 
> described. Old application, fixed window size, for Informix. 
> Previously maintained by developers and plus one tech writer, 
> as of recently. 
> New developments, UI platform has been upgraded, but the 
> items, fields in the dialogs are the same -- so screenshots in 
> the document need to be recaptured. Aaaah.
> I have one single large word document. 
> * Should I break up into smaller sub documents by application 
> modules thus easier to assign work? But then I lose my 
> integrated Table of Contents.
> * Should I remove all screenshots and for every dialog? 
> What's your experience for printed documentation?
> * I keep the whole thing as one single large document as it is. 
> I read that the Master Document feature is terribly 
> dangerous, it corrupts, an ill influence.:) Good thing we 
> started enforcing the document out well with basic and simple 
> use of Word styles. -- my contribution as tech writer:)
> Perhaps this is one of those questions people keep asking; 
> pros and cons regardless of the method. Perhaps your 
> collective experience could shed some light.

This message contains confidential information intended only for the use
of the addressee(s). If you are not the addressee, or the person
responsible for delivering it to the addressee, you are hereby notified
that reading, disseminating, distributing, copying, electronic storing
or the taking of any action in reliance on the contents of this message
is strictly prohibited.  If you have received this message by mistake,
please notify us, by replying to the sender, and delete the original
message immediately thereafter.  Thank you.





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

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author 
content and configure Help in MS Word or any HTML editor. No 
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005

---
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- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.