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

Improve --help documentation to match full documentation #76

Open
sefeg opened this issue Mar 21, 2018 · 0 comments
Open

Improve --help documentation to match full documentation #76

sefeg opened this issue Mar 21, 2018 · 0 comments

Comments

@sefeg
Copy link
Member

sefeg commented Mar 21, 2018

In the last user test iteration, we commonly observed analysts attempting to use cap-client --help to find a command to perform a desired task. They drew back on --help, even though the full documentation was already loaded in the browser. While the full documentation proved to be helpful for all tasks, this was not the case for the command overview resulting from --help. For example, a user who wanted to update an analysis field, did not manage doing so with the command line --help. It only lists metdata with the description Metadata managing commands. As we see that the full documentation is effective, improving the --help overview by drawing back on already existing descriptions should improve the usability.

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

No branches or pull requests

1 participant