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.
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
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.
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,
Satyam Computer Services Ltd.,
Phone: 8206120 Extn: 5747
"Smile is contagious but harmless disease"
> can someone please define a document or documentation process.
> 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: www.twin-india.com and
> TWIN Archive: http://user.itconsult.co.uk/twin/archive/
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.