RE: User Documentation in XP environment (Possible Process)

Subject: RE: User Documentation in XP environment (Possible Process)
From: david -dot- locke -at- amd -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 3 Oct 2001 08:58:34 -0500

XP was motivated to be methodology light. One of the troubling aspects of
methodology is that the meta deliverables become the deliverables. Stories
are supposed to be about the deliverables not the process used to create the
deliverables. The programmers do not have stories for coding and testing.
Neither should you.

XP focuses the programmer on coding. The architectural considerations that
usually precede programming are eliminated from the process. Instead, they
write code, they lean, they refactor, they rewrite code. The same should be
true for TW. They should write, they should learn, they should refactor,
they should rewrite.

The story is the product itself. The documentation story is the story about
using the instructions to do the tasks coded in the software. The stories
should be finding the topic using the TOC, finding the topic using the
index, displaying a topic using the F1 key, performing the task from the
instructions. All but the last of these require coding to support them. The
programmers have to work here as much as the TW. Likewise, testing should
focus on these same tasks.

A process focus is definitely not XP.



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

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

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: RE: Bonus instead of raise -- why?
Next by Author: RE: Re. How to document multiple user roles?
Previous by Thread: RE: User Documentation in XP environment (Possible Process)
Next by Thread: Re: User Documentation in XP environment (Possible Process)

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

Sponsored Ads