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

Examples assume programming experience #2

Open
camerons opened this issue Nov 8, 2019 · 1 comment
Open

Examples assume programming experience #2

camerons opened this issue Nov 8, 2019 · 1 comment

Comments

@camerons
Copy link

camerons commented Nov 8, 2019

I notice that examples in the README.md are based on programming examples, and we should select examples which a product user can relate to.

Existing programmer specific example:

The cognitive load of using an acronym or an abbreviation is similar to wrapping a class with a long name in a class with a shorter name. So, create acronyms sparingly.

This example assumes the reader will be a programmer who understands the term class.

From my experience in developing Project Overviews and Quickstarts for ~ 50 open source projects for OSGeoLive (https://live.osgeo.org):

  • ~ 3/4 of the volunteers creating docs were open source developers, and this example would have worked for them.
  • ~ 1/4 were application users who were wanting to give back to the project and found that documentation provided the opportunity to give back.
  • The application users are generally an untapped market for writing docs. They typically find it hard to contribute due to the high barrier to entry of learning software documentation tools. (They are typically used to working with Microsoft Word or Google Docs). More about attracting user communities in this blog post: http://cameronshorter.blogspot.com/2019/02/inspiring-techies-to-become-great.html
@camerons
Copy link
Author

camerons commented Nov 8, 2019

A good suggestion from your document below is "State your document's audience". While this document does imply an audience, it doesn't go as far as profiling them and the audience description probably should be expanded. I feel this document is based on an assumption that the reader has software developer experience; in particular, it uses linux based terms like "bash" which only a subset of programmers will understand.

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