Features

Guidelines for Feature writing

The level of detail required for each feature will depend upon the scope and complexity of what it needs to deliver.

To remove single points of failure, and to promote transparency, it is important each feature is well documented and contains the following sections.

• Name: A short and clear title which those inside and outside of WP4 should be able to understand.
• Summary: A few sentences giving more detail regarding the scope and goals of the feature.
• Requirements and User Stories: This section is key to providing the transparency between requirements and technical deliveries. It must be clear to reviewers and the consortium the requirements and user story that each feature aims to address.
• Owner: The name of one person responsible for delivering this feature, ideally the main person working on it.
• Description: A detailed summary of what outcomes this feature needs to achieve, the expected challenges, and supporting information to help quantify the expected effort/time.
• Technical Information:
  • Which repository is this feature’s code saved in?
  • What coding languages are used
  • What component type? Storage, Service, API, Front End, Security etc.
  • Where can technical documentation be found (e.g. readme.md)
  • What alternative approaches / languages were considered?
  • Which secure location are passwords/user names stored?
• Dependencies: A list of any feature(s) this depends on.
• Benefit Hypothesis: An explanation of the measurable added value this feature offers to the project. This section should include links to the detail of the requirements/user stories it is delivering a solution for.
• Added Value: A placeholder for information which helps support prioritizing this feature, for example:-
  • Which users are impacted?
  • What percentage of those users are impacted?
  • How often will this feature be used?
  • Does this feature remove/reduce any risks?
• Acceptance Criteria: How will this feature be tested, and how will we know if/when it is ready for deployment?
• Risks: A placeholder for any foreseeable issues on any other feature(s) on which it may depend, and reference to technical debt this feature may create.