need new/updated "User Guide" ("Help" in header at right) since UI has changed a lot, etc.
#16 opened on Jul 26, 2025
Repository metrics
- Stars
- (2 stars)
- PR merge metrics
- (PR metrics pending)
Description
There is a link called "Help" at the upper right of the main page of UI. It points to a pdf User Guide that was intended to help the average user or a beginner with how to use the web app, step by step, with screenshots and some explanations.
This is a "bug" in the sense that it is part of the live web app but has incorrect information right now since it is very outdated.
If anyone wants to draft or help draft a new user guide, the exact format or level of detail is not set in stone! -- The idea is just that a potential user or an inexperienced user of the web app could look at it and find it helpful. Lots of people first encountering ejscreen used to ask for a simple "user guide" or training or walk through. We heard the same questions as people started to look at EJAM - some people really want a simple doc to look at.
Current and older versions of userguides are collected in the data-raw folder of a branch, here: https://github.com/ejanalysis/EJAM/commit/6272244ec3fccc54591750283aa6966b0ef0791c
The 2/25 (last version of the) EJAM pdf is there, but is not a great model -- screenshots are missing and the name of the app is wrong/obsolete, and "EJ" terms had been edited. https://github.com/ejanalysis/EJAM/commits/main/inst/app/www/user-guide-2025-02.pdf
The 1/25 version of the EJAM guide was a good model -- actually had useful screenshots, etc., but they were removed around 1/2025 since the UI changed... new ones would be needed now.
The 1/25 pdf was created from a word doc, which could be a good place to start to edit and turn into a new pdf. If you want that original word .docx file, contact me.
The EJSCREEN User Guide is also in that folder, for comparison, but it is arguably much more detailed than ejam needs.