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: User Documentation in XP environment (Possible Process)
Subject:RE: User Documentation in XP environment (Possible Process) From:"Steve Hudson" <steve -at- wright -dot- com -dot- au> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 3 Oct 2001 13:45:59 +1000
Laura I don't like the idea from two points.
#1: XP writing has the reviewer watching the writer... they share the task
same as the softies share the coding tasks in pairs.
#2: A module review (iterate iterate iterate) won't generate a full story.
I DO like the general tasking idea though - ie - each module concept needs a
story behind it. The story will require changes as it develops, with
traditional change management to control that.
Steve Hudson
Principal Technical Writer
Wright Technologies (Aus)
steve -at- wright -dot- com -dot- au
(612) 9518-1822
The best way to predict the future... is to create it!
-----Original Message-----
From: Laura spencer
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.
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.
