RE: not an artifact, just a document

Subject: RE: not an artifact, just a document
From: "Dan Goldstein" <DGoldstein -at- riverainmedical -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 21 Dec 2005 16:39:31 -0500

A document:

* Conveys information directly to a human user. This is as
opposed to project artifacts like software code, which
convey information directly to other software, firmware,
or hardware.

* Is portable and usable in both printed and electronic format.
This is as opposed to a GUI, which might convey information
directly to a human user, but only within the context of its
host OS and/or hardware.

Additions and corrections to this definition are welcome!

-- Dan Goldstein

> -----Original Message-----
> From: Tara Charter
> Sent: Wednesday, December 21, 2005 1:08 PM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: not an artifact, just a document
>
> My Documentation Plan states that the plan is applicable to project
> artifacts that are documents. While I realize not all project
> artifacts are documents, I was informed today that a document is
> "any project deliverable not part of development" (eh?)- doesn't
> make any sense at all.
>
> I want to say the doc plan refers to *.doc format only. However, that
> is not accurate, because it could apply to a Development Case, for
> example, documented as in *.xls format. A certain company defines
> Artifacts and Documents as follows (which is also not helpful because
> it states an artifact is 'any item' while a document is an artifact
> subset that can be 'stored retrieved and exchanged' - a very
> large set, too large for a doc plan)...
>

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 archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com

To subscribe, send a blank email to techwr-l-join -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.


Previous by Author: RE: Document Review Techniques
Next by Author: RE: Don Norman on Manual Writing
Previous by Thread: Re: not an artifact, just a document
Next by Thread: Contracters - billing for driving time?


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

Sponsored Ads


Sponsored Ads