Have a question about this requirement?

Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.
Requirement

Written documentation is released for every new release of the software

Functional Area

General

Industries
All
DETAILS

Description

The availability of comprehensive written documentation for every new release of the software is ideal to assist all users in understanding updates, new features, or altered functionalities. These documents also give insights into potential performance or security enhancements.

Example Use Case

Scenario: A business runs SaaS planning software for their global business. Updates to the product happen every quarter, with major releases twice a year. After three years on the platform, the business hasn't made any changes to how they use the software.

Solution: The software provider furnishes a user-friendly written documentation detailing every new release. Users can review the enhancements and can apply them to their model in order to continue getting value from their investment. They are also warned of potential bugs that have negatively impacted their use of the system.

Considerations

This documentation should ideally include training content to enable users, without the help of a consulting team, to implement those new features if appropriate. It is helpful if the documentation contains sample use cases to help the user understand how they might use the features in their specific setting.

Most business software companies will send an email to account admins announcing changes to the system along with release schedules. They vary in quality and frequency. Those announcements then appear in the documentation.

Questions to Ask a Vendor

  • Availability: Do you provide written documentation with every new update? Who receives it?
  • Timing: Is the documentation released simultaneously with the software update, or can we expect a gap between functionality release and documentation?
  • Education: What about training on the new releases? Is that a part of the documentation?