Skip to content

User guide style: Are the questions appropriate #140

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

Closed
longr opened this issue May 14, 2019 · 0 comments · Fixed by #152
Closed

User guide style: Are the questions appropriate #140

longr opened this issue May 14, 2019 · 0 comments · Fixed by #152

Comments

@longr
Copy link
Contributor

longr commented May 14, 2019

The questions in each section of the style guide feel (to me) as if they are written for a more technical user. If we the guide is aimed at such users, then it may be appropriate, but if we want to get more lower ability users using it, then it may be that the questions need re-wording. Some examples are:
How do I describe inputs to a command? --> How do I pass arguments to commands?

How do I describe outputs from a command? --> Where does my output go, and how do I keep it?

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 a pull request may close this issue.

1 participant