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

Need good user DOCUMENTATION for Yasmine #52

Open
rcasey-earthscope opened this issue Mar 12, 2024 · 1 comment
Open

Need good user DOCUMENTATION for Yasmine #52

rcasey-earthscope opened this issue Mar 12, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@rcasey-earthscope
Copy link
Collaborator

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.

@rcasey-earthscope rcasey-earthscope added the documentation Improvements or additions to documentation label Mar 12, 2024
@metempleton
Copy link
Collaborator

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).

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