zzawook / pe

0 stars 0 forks source link

Order of commands in user guide should be organized into command types #5

Closed zzawook closed 1 week ago

zzawook commented 1 week ago

image.png

The current user guide's detailed explanation about commands are organized rather randomly. The users are more likely to look for similar commands that matches their use-case. However, currently, for example, sort and clear command comes before addGrade and removeGrade command in the user guide, which seems counter-intuitive considering the use-cases.

To support that end, the command should be organized into some category - such as general command (help, filter, sort, clear, import, export), student command (add, edit, etc.), and lesson commands (mark, unmark, addgrade, removegrade) - and sort within the category according to relevance and general industry user guide convention.(student command first, lesson command next, then general command; within student command, add then edit, within general command, filter then sort then clear, export, import, then help)