RE: [twin] define a document or documentation process

Subject: RE: [twin] define a document or documentation process
From: Uma_Nakkeeran <Uma_Nakkeeran -at- satyam -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 12 Sep 2001 15:28:15 +0530

A documentation/ document process - is a process which explains the set of
activities to be carried to complete certain tasks (the user documentation
and online help).

A process clearly specifies the
objective(s); roles and responsibilities; Process description, entry
criteria, exit criteria, deliverables, quality records(if required) and
authorization details.

Objective as specified in the first two lines

roles & resp : who has to do what work?

entry criteria : inputs in the form of SRS/ functional spec, etc

process desc : clearly and specifically describes what and (by whom the)
activities have to be carried out. To describe the process one needs to
understand the flow of the technical writing....
Prior to writing, the writer is expected to understand the technicalities of
the project/product. For that, he/she should be briefed about the
product/project...If need arises, they may have to see a demo...then the TW
charts out a plan as how to go about.

Exit criteria
draft documents,(in soft/hard) records, etc

Quality records
technical review, editorial review forms
Checklist for final review on formats, grammer, etc

Manuals, online help formats.

Authorization details at the end

With Warm Regards,
Uma Nakkeeran
Satyam Computer Services Ltd.,
Phone: 8206120 Extn: 5747
"Smile is contagious but harmless disease"

> can someone please define a document or documentation process.
> Thanks
> ram
> .........................000000000000................................
> TWIN (Technical Writers of India)
> Send messages to: twin -at- user -dot- itconsult -dot- co -dot- uk
> Send commands (join twin, leave twin) to: list -at- user -dot- itconsult -dot- co -dot- uk
> List Owner: twin-owner -at- user -dot- itconsult -dot- co -dot- uk
> Technical problems: support -at- itconsult -dot- net
> TWIN web site: and
> TWIN Archive:


A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe.

+++ Miramo -- Database/XML publishing automation. See us at +++
+++ Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion +++
+++ More info: +++

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 for more resources and info.

Previous by Author: OT: Act of Barbarism
Previous by Thread: Sympathy from Israel
Next by Thread: Using the STOP methodology

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

Sponsored Ads