RE: Best Documentation

Subject: RE: Best Documentation
From: Lisamarie Babik <lmbabik -at- winspc -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 28 Jan 2000 11:05:12 -0500


-----Original Message-----
From: Mark Baker [SMTP:mbaker -at- omnimark -dot- com]

> "Best documentation" should be saved for documentation that solves a harder
> problem.

I don't agree with this at all. "Best documentation" is whatever communicates
effectively to its audience. I don't think it's reserved for only "harder"
problems.

The lego instructions, for example, tackle the complexity of the process of
building (vs. assembling) something which is essentially free-form, and
communicates it to a target audience aged 5-12.

For the record, I see the difference between assembling and building as this:
assembling is a pre-determined pattern, every one you make will be exactly the
same. Building is how to put the components together to build whatever you
want, with each one potentially being the same or each one being completely
unique.

How would you document a "process" where every end product is different?

--
Lisamarie Babik
lmbabik -at- winspc -dot- com
Documentation Specialist






Previous by Author: RE: iff vs. if in documents
Next by Author: RE: Training docs vs. user documentation?
Previous by Thread: Re: Best Documentation
Next by Thread: Best documentation


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

Sponsored Ads


Sponsored Ads