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

How to write and structure a concise manual of SciCat for users #1

Open
rkweehinzmann opened this issue Oct 22, 2024 · 1 comment
Open

Comments

@rkweehinzmann
Copy link
Collaborator

Here is how I imagine a user would approach SciCat. Basics are known but only in a fuzzy way.

  1. Front page of SciCat says in a very short form (2 to 3 sentences):
  • Present benefits when using SciCat besides FAIR data
  • What SciCat is meant for (finding back data, eg to have an overview which data are used for users analysis)
  • Present the most prominent features (How to search, publish datasets, request a DOI, retrieve datasets),
  • Highlight data structures: guide the user through Dataset, Proposals, Instruments, Sample. Say which is most elaborated and plans.
  • Emphasize it's about the meta data. Data access is not necessarily granted but can be added (site-specific decision, link to site-documentation of SciCat?)
  • Mention the difference if authenticated or anonymous (user can see meta data of those he has right too and public otherwise only public).
  1. More details per respective features mentioned above. In addition potential actions users may want to do after data taking and ingestion.
  • How to change some fields after ingestion
  • How to view history of changes to a dataset
  • How to group and tag datasets
  • How to group and tag grouped datasets
  1. Trouble shooting/features under development/Known issues
  • What if ...
  • Q&A; our contact
  1. Glossary
@rkweehinzmann rkweehinzmann changed the title How to write, structure a concise manual of SciCat for users How to write and structure a concise manual of SciCat for users Oct 22, 2024
@rkweehinzmann
Copy link
Collaborator Author

Dear Laura and all,

I drafted a new user manual in my public repo:
https://github.com/rkweehinzmann/user-sc-manual/

with more question to be answered. Currently fixing CI so preview can be easily seen.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant