OpenEnergyPlatform / organisation

Repository for discussing and documenting decisions about the Open Energy Family
https://openenergyplatform.github.io/organisation/
GNU Affero General Public License v3.0
10 stars 4 forks source link

[Compendium] Guide the user when searching for specific information about the OEF #58

Open jh-RLI opened 1 year ago

jh-RLI commented 1 year ago

What is this issue about?

As we discussed at the project meeting in Kassel:

The compendium will exist alongside the Academy and the Open Energy Platform website. We do not want to confuse users by presenting the compendium as another source of information. Therefore, clear guidance needs to be given on which resource is aimed at which goal (what information the user can get).

This affects all the resources mentioned (oep/academy/open energy platform/...maybe more) and requires a restructuring of the visible content.

What needs to be done:

jh-RLI commented 1 year ago

These are roughly the paths that are relevant for user guidance. Please let me know if you see any other paths. I added recommended paths, but came to the conclusion that it is better to use guides and display them in the compendium, so the coloured paths do not have quite as much meaning as they are displayed now.

image

christian-rli commented 1 year ago

Thanks for compiling everything @jh-RLI . Those are a lot of places to browse and I have none to add. I think the biggest challenge will be to create a concise characterization for all pages that can guide users to the most helpful resource at first glance.

jh-RLI commented 1 year ago

I also discussed this with Ludwig and he added a good point. This picture should be used as an oef map and presented to the user. My intention was only to give a visual overview where links should be added ... but a "map" where the user can orientate themselves and have an "I am here" marker would be really useful. But I agree that the challenge is to decide how to guide the user/developer in detail.

I will create a simplified version and ask @bmlancien to help me create a useful visualisation.

We all should try to create (basic) guides for different point of views like users/developers and maybe one for a general family overview.