Skip to content

D5 review check for PRD #8

Description

@AIBappa

The D5 review check should be visible before check runs.

  • Additional reviews should be possible if user desires them. This will allow user to use their own knowledge to update the review. So certification specific aspects can be noted here.
  • Review role should be a drop down . Systems engineer, software engineer, project manager, test engineer, quality engineer and safety engineer roles can be defined.
  • A set of default built-in checks should be shown as follows. They can be toggled on/off. A new check can be added with name and description as part of additional review.
  • product_name_check: Checks if product name is appropriate and suits the product. Suggestion for better names.
  • function_name_check: Checks if function name is appropriate and suits the function description. Also suggest better names.
  • product_division_check: Key check which checks if product description, primary use case description and all functional descriptions associate properly. If a function is not defined, it will highlight that. If functions overlap or can be clubbed into one function, this will inform. so key aspect is to determine the number of functions that a product should be divided into.
  • product_future_upgrade_check: Upgradeability options for product future upgrades.
  • function_reduction_check: Key check that checks if function description is good enough or can description length be reduced (perhaps with some industry standard terms) or needs more clarification in certain areas.
  • function_product_alternative_check: Per function check that determines if there are other functions that can be better alternatives for the product. It suggests alternatives and can be a strong factor to determine early on if function can be maintained with product suitably.
  • cross_function_impact_check: Each function is checked against other every other function keeping in mind product description. Should technically overlap with product_division_check, but is kept here anyways to highlight in-depth details.
  • function_future_upgrade_check: Upgradeability options for future function upgrades.
  • product_user_check: Checks the user roles versus product description, if user requirements are likely to be met or not or exceed with product. Also suggests additional user cases that can utilise the product.
  • product_interface_check: Key check that checks the various infrastructure needs for the product, e.g. webapp, BFF, backend etc. It suggests if some interfaces may not be required or some additional interfaces could be.
  • function_interface_check: Key check that checks the various infrastructure needs for the function e.g. webapp, BFF, backend, external links and suggests if some interfaces may not be required or some additional interfaces could be.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions