SciCatProject / user-documentation

For all the user facing documentation. Developer documentation will sit alongside the code
Apache License 2.0
0 stars 1 forks source link

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

Open rkweehinzmann opened 1 month ago

rkweehinzmann commented 1 month ago

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

2) More details per respective features mentioned above. In addition potential actions users may want to do after data taking and ingestion.

3) Trouble shooting/features under development/Known issues

4) Glossary

rkweehinzmann commented 3 weeks ago

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.