Software Documentation

Subject: Software Documentation
From: Sue McKinney <smckinn2001 -at- yahoo -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Mon, 7 Mar 2011 05:11:28 -0800 (PST)

In my office, some of us are having a debate about the appropriate content for a
document set for software, such as requirements, use cases, design, and so on.
Is there a good source that outlines what a good documentation set is and
what each document should include? Part of the confusion is over who the
audience is as well as how to include information that changes frequently.

Please respond to me individually as well as to the group as I'm on digest.

Sue McKinney


Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.

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.

Please move off-topic discussions to the Chat list, at:


Previous by Author: Re: Coaching less experienced folks on asking good questions
Next by Author: Re: Software Documentation
Previous by Thread: Re: HTML Help and Touchscreens
Next by Thread: RE: Software Documentation

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

Sponsored Ads