You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
Type xxx in the command box
Press 'Enter'
The xxx will now be added to the list, which can be seen in the display box.
If the command format is wrong, xxx happens
If any of you have any points, feel free to comment below.
The text was updated successfully, but these errors were encountered:
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:
If any of you have any points, feel free to comment below.
The text was updated successfully, but these errors were encountered: