Skip to content

User documentation ready for discussion #5

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

Open
wants to merge 24 commits into
base: main
Choose a base branch
from

Conversation

rkweehinzmann
Copy link
Member

Dear all,

please take a look at the user documentation. In some cases there are still place holders, eg. in jobs or instruments. Any feedback is welcome, please put any questions you would like the user documentation to answer.

The structure is to ease interconnection with the operators guide. However, please focus only on the user part for now, thanks.

Cheers,
Regina

Copy link
Collaborator

@LAShemilt LAShemilt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a really great start to the user documentation and I think it should be merged pending the requested changes are done.

I have a few overarching comments to this review:

  1. Audience. Whilst I like the style of this guide in places I think it is not clear who are audience is. Is this a help guide or technical documentation? It feels a bit like the two.
  2. Pronouns. We should agree a strategy for pronouns in the documentation. If it is a help guide, I favour you throughout. If we want to make it more formal and refer to the user then we should use either “s/he” or “they” as the pronoun
  3. Impact of messaging. This is the first entry point into SciCat we want the guide to be readable, accurate and clear, but we want people to use SciCat so we need to make sure that the guide demonstrates the advantages of this system.

I think we could look at the structure again on another MR. Addressing it here will make things quite comples.

Copy link
Collaborator

@LAShemilt LAShemilt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes

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

Successfully merging this pull request may close these issues.

2 participants