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

[DISCUSSION] Rewriting User Guide #110

Closed
C-likethis123 opened this issue Oct 15, 2019 · 2 comments
Closed

[DISCUSSION] Rewriting User Guide #110

C-likethis123 opened this issue Oct 15, 2019 · 2 comments
Labels
Discussion documentation Improvements or additions to documentation

Comments

@C-likethis123
Copy link

This is a discussion on how we can divide the workload for the user guide, and how we can rewrite the user guide to improve readability.

Current issue
Currently, the user guide format is based off the AB3 User Guide. AB3 commands are short and simple, so the user guide format is okay for AB3. ORGANice has longer commands and more features. Using that format results in a messy user guide.

Proposed change
I suggest that the user guide could be written like it is talking to the user.
Eg: Let's say you want to add the following patient to ORGANice.... Type the command in the command box.

Also, each command should be accompanied by steps.
Eg:

  1. Type xxx in the command box
  2. Press 'Enter'
  3. The xxx will now be added to the list, which can be seen in the display box.
  4. If the command format is wrong, xxx happens

If any of you have any points, feel free to comment below.

@C-likethis123 C-likethis123 added documentation Improvements or additions to documentation Discussion labels Oct 15, 2019
@iskandarzulkarnaien
Copy link

Related to #104

@C-likethis123
Copy link
Author

Closed as we have reached a consensus on how to author our user guides.

Other enhancement/refactor automation moved this from To do to Done Nov 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Discussion documentation Improvements or additions to documentation
Projects
Development

No branches or pull requests

2 participants