Some small adjustments to the README.md for new users #1919
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
rvagg
approved these changes
Oct 15, 2019
rvagg
pushed a commit
that referenced
this pull request
Oct 24, 2019
PR-URL: #1919 Reviewed-By: Rod Vagg <rod@vagg.org>
|
landed in 3538a31, sorry for the delay |
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
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.