Component Release Documentation

Owned by Former user (Deleted)
Last updated: Sept 04, 2009Version comment
1 min read
  1. A breakdown of feature changes, including:
    • What the feature aims to accomplish and who should benefit from it - explained in clear, simple language.
    • Any JIRA issues that relate to the feature change.
  2. Stepwise documentation of what the new functionality does, in enough unambiguous detail that testers can confirm it behaves as intended.
  3. Documentation of other technical considerations as appropriate, e.g.
    • What other dependencies are assumed, if any, and potential implications for other tools/functionality. e.g. does it include any API changes, or will a helper have a new workflow?
    • Are properties leveraged for this functionality? If so, what are they and what do they do?
    • What are the DDL and DML needs of this change? Is any data conversion required for this feature? If so how long will that conversion take?
    • What factors influence non-UX performance? E.g. Do calculations depend on the total number of users, or the number of users in a site, or the number of entries in a forum? Is performance linear or non-linear in those factors?
    • Are there any security implications of the change?