views:

92

answers:

3

I am supposed to manage the software release process for a product release scheduled this month. Somehow, I couldn't find a good release guide for the different kinds of documentation involved in a product release. The best I could think of at the moment are:

  • Release notes
  • User manuals
  • Installation document

Are there any other documents that should be bundled with a product release? Is there a standard to this?

+3  A: 

Anything that is necessary or helpful for the user should be bundled with the product. There isn't really a standard to what should be bundled, but easy to read and concise documentation is always good.

Some examples of user documentation include:

  • Readme.txt (last minute changes, etc)
  • Version History (major changes, bug fixes)
  • Installation instructions
  • User documentation (help file)
  • Link to your website with additional documentation (knowledge base/support contact information)
Kyle Trauberman
+2  A: 

Who asked you to manage the release documentation? Who are you releasing to? What are their expectations re. documention? Has your org ever released in the past (and if so with what documentation)?

What other documentation do you have already (which may or may not be categorized as "release documentation"): for example do you already have software development project management documentation (how to build, bug database, list of requirements, project backlog)? Do you have business/accounting documentation? Do you have marketing literature? A list of customers?

ChrisW
+1, this is more a question to ask the Project Manager than one to ask StackOverflow.
Adam Luchjenbroers
+3  A: 

As answered before - it significantly depends on what kind of software you are working on and which practices are considered best in your organization.

Though, here is a release checklist that I used to use when releasing one of my products (not only documentation)

  • Label Release in Source Code Control System
  • Create version in CRM System
  • Create product and queues in CRM System
  • Check Redistributables
  • Shared components
  • CD Autorun Contents
  • Evaluator's Guide
  • Product Overview
  • Quick Start Guide
  • User Guide
  • What's New
  • Verify EULA is current in all UI Languages
  • Web Download Layout
  • WebEx(or GotoMeeting) for Support
  • Support Training Script
  • Training for Support
  • Put Binaries to Release location
  • Send RTM Message
  • Mark Version Commercial
  • Upload to fulfillment
  • Verify CD from fulfillment
  • Download available
  • Sales notification
  • Customer notification

Hope this helps!

lkurts