Skip to content

Presentation of the report #18

@llrs-roche

Description

@llrs-roche

The report is for three groups of people:

  • non-technical people: leadership and decision-makers
  • technical people not familiar with the package and
  • technical people familiar with the package

It should be easy to read for them, here are some issues to improve:

  • Provide a summary of all the report at the top (Executive summary or something)
  • Condense long content: For example, options or environmental variables are not useful initially (only when there is some problem with the image or compared to other production environments), it can be hidden or de-emphasized. For Be mindful about options and variables exposed #7 For this we can use this hook for the html reports or similar tricks.
  • Provide plots, and colors that make it easier to see the assessment

Other reporting tools to take examples:

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requesthelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions