TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:not an artifact, just a document From:"Tara Charter" <tara -dot- charter -at- physiciansmutual -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Wed, 21 Dec 2005 12:08:02 -0600
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):
Artifact ?
1) Any item (such as a use case, functional design specification,
vision document, etc.) that is input to or output from the software
development process, or tools, etc. The artifact itself may not be
considered reusable. There may be many artifacts in an asset. (2) A
physical piece of information that is used or produced by a software
development process. Examples of artifacts include models, source
files, scripts, and binary executable files.
Document ?
(1) An item that can be stored, retrieved, and exchanged among Content
Manager systems and users as a separate unit. It can be any multimedia
digital object. A single document can include varied types of content,
including for example, text, images, and spreadsheets.
(2) In RequisitePro, a Microsoft Word document that can be part of the
RequisitePro project, or outside of the project.
(3) Any collection of data stored in a document object. A document can
contain any type of data. For example, the iSeries Access shared
folders function can store any data that could otherwise be stored in a
PC file; a server application can store any data into a document by
using CL commands, such as FILDOC and RPLDOC. The system-recognized
identifier for the document object type is *DOC.
Tara C.
Tech Writer
____________________________________________________________
This message and any attachments are confidential, may contain privileged information, and are intended solely for the recipient named above. If you are not the intended recipient, or a person responsible for delivery to the named recipient, you are notified that any review, distribution, dissemination or copying is prohibited. If you have received this message in error, you should notify the sender by return email and delete the message from your computer system.
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-
