Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Presentation of the report #18

Open
llrs-roche opened this issue Jan 9, 2025 · 0 comments
Open

Presentation of the report #18

llrs-roche opened this issue Jan 9, 2025 · 0 comments

Comments

@llrs-roche
Copy link
Collaborator

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant