Documentation included in software build

Subject: Documentation included in software build
From: carthur <carthur000 -at- sympatico -dot- ca>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 4 May 2004 9:55:16 -0400


A project manager has asked if we could include documentation in the software builds to ensure that the docs associated with a particular release can be found easily.

I have some concerns about this, chiefly that we are updating release notes after the final software build, although I do not think they would mind if a further build was included simply to incorporate the documentation. There is usually from 5 - 10 documents in addition to the release notes that describe new features of the software. The software is internal and documentation is not controlled by ISO or any group within the company. We place pdfs of the final documents in a single folder in Perforce (revision control software)that is accessible to anyone with Perforce. We will also be linking to those docs from the intranet in the near future.

I do not want to include documentation in the progressive builds, as items can come in and out of the documentation if a bug is found that cannot be solved for this release and must go into known issues.

Do any of you have experience with including docs with a software build? Good, bad or indifferent - and why?




SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more!

>From a single set of Word documents, create online Help and printed
documentation with ComponentOne Doc-To-Help 7 Professional, a new yearly
subscription service offering free updates and upgrades, support, and more.

You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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: To Index of not to Index
Next by Author: Re: 2 weeks !
Previous by Thread: Re: Don't say what you CANNOT do in documents
Next by Thread: Re: Documentation included in software build

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

Sponsored Ads