Publishing Documentation in Microsoft Word - Don't Do It!


© Tanja S Rosteck
Articles in this Topic    Discussions in this Topic

To save costs, many small businesses take the do-it-yourself route to publishing product and support documentation. The tool of choice is often Microsoft Word - after all, you probably already have a copy of it and know how to use it reasonably well. But while using Word to *develop* your materials is an acceptable choice, using it to *publish* documentation is not! Read on to learn some of Word's shortcomings as a publishing method, and what alternatives are available.

** SECURITY ISSUE #1: THERE IS NO "DOCUMENT SECURITY"

Simply put, there is no "document security" in Word. Anyone with a copy of your document can change the text, formatting, layout, form fields, your copyright notice, and so on. Word does offer password-protection for documents, but this doesn't prohibit the reader from changing anything while viewing it or saving it to another file name.

** SECURITY ISSUE #2: CAN'T HIDE THE META DATA

Even more critical is "meta data" - private information such as the author's name (or network ID), name of the company your copy of Microsoft Office is registered to, total amount of time the document was worked on, and so on. This data is embedded automatically in every single Word document. To see what kind of information you could be leaking out, open any Word document and click on File / Properties.

Microsoft admits there is no easy way to remove all of the metadata information, although some of it can be "reset" via various procedures. Apparently an option exists in the new Word 2002 (Office XP) to make this easier, but again, it's not a simple procedure and the onus is still on you to remember to do it.

** COVER YOUR TRACKS (TRACKED CHANGES, THAT IS)

Word has a feature called "Track Changes" that helps people sharing a document to track what has been changed and by whom. If you use this feature but forget to fully disable it before distributing your document, you now have an instant, visible audit trail of document revisions. If you had any sensitive information in there, consider it no longer private.

Alcatel, an American telecommunications company, fell victim to this mistake earlier this year when they published a Word-format press release concerning a known security vulnerability in their DSL modem products. Read the story at http://morons.org/articles/1/188.

** THE INCREDIBLE SELF-INFLATING DOCUMENT

A 200-page Word document with 25 screen shots can easily total 5MB in size. Add more graphics or cross-references, and watch the file size magically balloon to 8MB or more. Your customers will probably not appreciate having to download a file of such a size, especially if they're on a slow dial-up connection - and especially if they're trying out your product before buying!

Go To Page: 1 2 3


Post this Article to facebook Add this Article to del.icio.us! Digg this Article furl this Article Add this Article to Reddit Add this Article to Technorati Add this Article to Newsvine Add this Article to Windows Live Add this Article to Yahoo Add this Article to StumbleUpon Add this Article to BlinkLists Add this Article to Spurl Add this Article to Google Add this Article to Ask Add this Article to Squidoo


Here's the follow-up discussion on this article: View all related messages

6.   Jan 10, 2005 6:43 AM
Microsoft Word is an expensive program, and it's unfair to require customers to own a copy just to be able to read your user manual.

Compared to other word processing programs, MS Word is re ...


-- posted by H2O


5.   May 13, 2003 9:51 AM
I read in this article that you could save the Word doc as a PDF via clicking on a button on the tool bar? Could anyone tell me where to find this? ...

-- posted by taliushee


4.   Nov 13, 2001 6:33 AM
I hope people wouldn’t take things personally like this and respect each other's openions and commit to the talking etiquette rules. ...

-- posted by salmaahmed


3.   Nov 13, 2001 6:30 AM
In response to message posted by cherylkirk:

First of all i would like to point out that I am a technical writer for a reasonab ...

-- posted by salmaahmed


2.   Oct 19, 2001 7:01 PM
Hello CherylKirk,
What a great response. That is the kind of information and dialog I expect to see. You responded with well thought out points and followed up with good examples. Thank you. ...

-- posted by VMTWriter





Join the latest discussions

For a complete listing of article comments, questions, and other discussions related to Tanja S Rosteck's Technical Writing topic, please visit the Discussions page.