Andrew's Challenge Accepted.
Wrong. I champion simple, cost-effective solutions that focus on technical==========================================
accuracy. I am not a lone writer. I have a number of writers working at my
firm.
In an earlier post, Andrew challenged me to look at the documentation
on the BlackICE website, which he claims to have been done by his
company. Herre is his challenge:
But I counter, how is it that my firm consistently wins technology-centric
awards for documentation if we are just producing spaghetti code? Go to
www.networkice.com. I *personally* wrote about 75% of the documentation for
them.
I have taken that challenge, and have downloaded from that
site the BlackICE Defender User Guide, a 950+ KB PDF file (72 pages).
I am currently evaluating it, and intend to produce an annotated version
of that file containing my comments.
My preliminary analysis has concluded that this document is mediocre
at best, is full of classic examples of bad writing practice, and certainly
wouldn't win any legitimate awards for excellence.
====================
| Nullius in Verba |
====================
Dan Emory, Dan Emory & Associates
FrameMaker/FrameMaker+SGML Document Design & Database Publishing
Voice/Fax: 949-722-8971 E-Mail: danemory -at- primenet -dot- com
10044 Adams Ave. #208, Huntington Beach, CA 92646
---Subscribe to the "Free Framers" list by sending a message to
majordomo -at- omsys -dot- com with "subscribe framers" (no quotes) in the body.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY.
http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Take XML and Tech Writing courses online! Our instructor-led courses
(4-6 hrs/wk) give you "hands on" experience at your convenience. STC members
get 20% off! http://www.online-learning.com/index.html.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -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.
Previous by Author:
Re: A question about education (long-ish)
Next by Author:
Andrew's Challenge Accepted (More).
Previous by Thread:
TECHWR_L: Using MS-Word for TW
Next by Thread:
Re: Andrew's Challenge Accepted.
Search our Technical Writing Archives & Magazine
Visit TechWhirl's Other Sites
Sponsored Ads