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

Some small adjustments to the README.md for new users #1919

Closed
wants to merge 1 commit into from

Conversation

dannypike
Copy link

Checklist
  • documentation is changed or added
Description of change

Documentation that expresses opinions rather than stating facts can be inappropriate.

A user may well only look at the documentation for a product when she finds that it does not work as she expects. If, within the first few lines of reading the introduction, she comes across a line saying "our product is easy to use", what is she to think? That the author believes that she must be stupid if she has not already got it to work? Or, worse still, the author thinks that the product is perfect and doesn't really need to be documented at all?

In my opinion. it is much better to keep to factual descriptions and helpful examples of typical usage in the product documentation. This is especially true of the first three paragraphs of the README. It shuuld avoid using words like "clearly", "obviously", "basically" and phrases like "all you have to do is...", "it is easy to use".

Such a README gives a much better impression to a new user, encouraging her to keep reading in the hope that the author may understand her predicament.

@dannypike dannypike mentioned this pull request Oct 14, 2019
Copy link
Member

@rvagg rvagg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice work, thanks for the contribution

rvagg pushed a commit that referenced this pull request Oct 24, 2019
PR-URL: #1919
Reviewed-By: Rod Vagg <rod@vagg.org>
@rvagg
Copy link
Member

rvagg commented Oct 24, 2019

landed in 3538a31, sorry for the delay

@rvagg rvagg closed this Oct 24, 2019
rvagg pushed a commit that referenced this pull request Nov 18, 2019
PR-URL: #1919
Reviewed-By: Rod Vagg <rod@vagg.org>
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 this pull request may close these issues.

2 participants