Re: Writing the User Docs first?

Subject: Re: Writing the User Docs first?
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: "Gordon McLean" <Gordon -dot- McLean -at- GrahamTechnology -dot- com>, "'Techwr-l'" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 5 Dec 2007 07:51:29 -0800

I've done it. At one past client, the software requirement spec was a highly detailed description of how features were supposed to
work, based on the Marketing experts' knowledge of how the prospective customers would expect them to work if the product being
developed was going to be competitive with the current industry giant's. I wrote the user doc based on that, the programmers coded
based on it and the testers compared all three.

The development environment did not have a name, Agile or other, but I think the company did stumble upon some aspects of what is
commonly known as "Agile."

Gene Kim-Eng

----- Original Message -----
From: "Gordon McLean" <Gordon -dot- McLean -at- GrahamTechnology -dot- com>
> Given that, in XP, there is a focus on little to no documentation during the
> design/build of the software, I've been pondering how the Publications team
> can fill that gap, namely by writing as complete a draft as early as
> possible and getting buy-in from the Dev team that they'll use the user docs
> whilst developing the software.
> Am I barking mad? Anyone working in XP (or any other Agile environment) care
> to chip in? Are our processes broken?


Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Writing the User Docs first?: From: Gordon McLean

Previous by Author: Re: Re: How do you differentiate yourself (UserFriendly)
Next by Author: Re: How is documentation distributed with your application?
Previous by Thread: Re: Writing the User Docs first?
Next by Thread: Re: Writing the User Docs first?

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

Sponsored Ads