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.
User Documentation in XP environment (Possible Process)
Subject:User Documentation in XP environment (Possible Process) From:Laura spencer <ljs199 -at- go -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 02 Oct 2001 19:21:32 -0700 (PDT)
For those colleagues working in an Extreme Programming environment, I would like feedback on the following:
With a colleague, I have come up with a possible process for writing online help and user documentation in an XP (Extreme Programming) environment.
We discussed having each story contain a simple task which basically requires that decision be made about whether that story should be documented (yes or no), and that each iteration contain a story to write the user documentation. The user documentation should contain two tasks--one for the writer and one for the reviewer. The task for the writer is simply to document the stories that were designated as needing documentation from the prior iteration. The task for the reviewer is to review the documentation.
Comments?
___________________________________________________
GO.com Mail
Get Your Free, Private E-mail at http://mail.go.com
Planning to attend IPCC 01, October 24-27 in Santa Fe? Sign up by
October 3 and get a substantial discount! Program information,
online registration, and more on http://ieeepcs.org/2001/
+++ Miramo -- Database/XML publishing automation. See us at +++
+++ Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion +++
+++ More info: http://www.axialinfo.comhttp://www.miramo.com +++
---
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.