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

[Feature] User documentation #1

Open
MathildeNS opened this issue Mar 15, 2023 · 3 comments
Open

[Feature] User documentation #1

MathildeNS opened this issue Mar 15, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@MathildeNS
Copy link
Contributor

Many users of the demo stopped at the creation of a project. Potentially because of the difficulty of using the tool for the first time.
Indeed, it is necessary to create objects and to understand the functioning and structure of GeoCam to use it.

This is why a short user documentation (which will be improved) has been published to help you understand how GeoCam works. It is available here: https://natural-solutions.gitlab.io/geonature/annotation/user/start/

We will also put a button in the header of the tool to access it easily from the tool itself.

@MathildeNS MathildeNS added the documentation Improvements or additions to documentation label Mar 15, 2023
@camillemonchicourt
Copy link

An simple tool don't require user documentation.
And when it is existing, user don't often read it.
So there may is another problem. A concept problem or ergonomic concept ?

@camillemonchicourt
Copy link

Peut-être qu'il faudrait dans la documentation, voire directement dans l'application, un schéma simplifié comme tu avais fait ds concepts pour les illustrer sans devoir lire une documentation.
Ou un schéma de ce genre (en joli...) :

image

Et il peut être utile de définir chaque concept directement dans l'application.

Par exemple, au niveau de "Mes projets", ajouter un ? à coté du terme et afficher sa définition au survol.

Idem sur les autres concepts centraux.
Là où vous affichez "Aucun déploiement" ou "Déploiements: 1" ou "Nouveau déploiement", ajouter un ? t au survol afficher sa définition très utile : "Le déploiement correspond à la localisation d’un dispositif donné sur une période définie par une date de début de déploiement et une date de fin de déploiement. Plusieurs autres caractéristiques peuvent lui être attribué comme des informations sur le placement du dispositif (hauteur et type de fixation), la présence d’appât... Les déploiements permettent au sein de l’outil de relier les médias à leur site, dispositif et projet respectif."

@MathildeNS
Copy link
Contributor Author

Effectivement, la piste d’un problème d’ergonomie n’est pas à écarter. Il est vrai que ce n’est pas la première chose à laquelle on a pensé puisque nous n’avions pas eu jusqu’à lors de retours clairs à ce sujet donc merci de soulever la question.
En effet, des infobulles sur les boutons et les concepts sont une excellente idée pour éclaircir l’utilisation de l’outil et simple à mettre en place.
De même, on peut en effet imaginer une modale qui présenterai ce schéma pour illustrer la structure de l’outil et les termes abordés.
En ce qui concerne la documentation, il est vrai que peu d’utilisateurs prennent le temps de la lire. Toutefois, celle-ci étant déjà réalisée autant la rendre accessible facilement aux personnes qui le souhaiteraient.
Merci pour tes retours c’est toujours un plaisir de pouvoir échanger et avoir l’avis d’autres personnes.

[english below]
Indeed, the possibility of a problem of ergonomics is to consider. It's true that it's not the first thing we thought because we didn't have any clear feedback on this subject until now, so thank you for raising the issue.
Indeed, tooltips on buttons and concepts are an excellent idea to clarify the use of the tool and simple to implement.
Similarly, we can indeed imagine a modal that would present this diagram to illustrate the structure of the tool and the terms covered.
Regarding the documentation, it is true that few users take the time to read it. However, since it is already done, it should be easily accessible to those who wish to do so.
Thank you for your feedback, it's always a pleasure to be able to exchange and have the opinion of other people.

@ophdlv ophdlv changed the title User documentation [Feature] User documentation May 10, 2023
killianrak referenced this issue in killianrak/ecoSecrets Apr 10, 2024
… 'dev'

Resolve "Revoir la gestion de la config pour centraliser"

Closes #1

See merge request natural-solutions/geonature/annotation!34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants