RE: Software Documentation

Subject: RE: Software Documentation
From: Fred Ridder <docudoc -at- hotmail -dot- com>
To: <smckinn2001 -at- yahoo -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 7 Mar 2011 08:44:21 -0500

Sue McKinney wrote:

> 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.

I'm afraid your question is too broad to get a answer that will be very meaningful to your specific situation. "Software" is an *extremely* broad category, which can include such disparate things as programming languages, operating systems, interface protocols, application development interfaces (APIs, which have become my personal specialty), enterprise/server applications (e.g., databases, business management systems, web services, CMSs), complex desktop applications (e.g. CAD and photo editing tools), and simple smart phone apps. It's all software, but each has its own, different kinds of audiences (some have multiple audiences) and its own requirements for documentation.

-Fred Ridder


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:


Software Documentation: From: Sue McKinney

Previous by Author: RE: Grabbing a Visio diagram from a Word document
Next by Author: RE: Help request--FrameMaker 8 (with Acrobat Distiller 9) won't createapdf
Previous by Thread: Software Documentation
Next by Thread: Re: Software Documentation

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

Sponsored Ads