search

iris-edu / yasmine-stationxml-editor

GNU General Public License v3.0
11 stars 3 forks source link

Need good user DOCUMENTATION for Yasmine #52

Open rcasey-earthscope opened 3 months ago

rcasey-earthscope commented 3 months ago

Yasmine does not have very complete documentation available, and as some features change, the preliminary documentation in the repo will be out of date.

The original documentation is the .docx file at the root of the Yasmine repo. We should mine that for content, but be ready to edit it.

Autumn started this online document that can be built out of GitHub. https://iris-edu.github.io/yasmine-stationxml-editor/user-guide/

We should consider if this is the form we want the documentation to take going forward.

metempleton commented 3 months ago

In addition to the explanations of each feature, the Document needs a cookbook section that walks users through a common task. How well that section is done makes the difference in how many user emails you get. I always thought the PDCC manual was a good example (but it needed a table of contents).