Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Commit

Permalink
Merge pull request #109 from thegooddocsproject/emckean-patch-1-linter
Browse files Browse the repository at this point in the history
linter fix (issue #66)
  • Loading branch information
camerons authored May 12, 2020
2 parents ef51245 + 075bdac commit cac108c
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions writing-tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Follow these writing guidelines when developing content using the templates avai

* Use consistent language and tone throughout your docs.
* Describe things as clearly and accurately as possible.
* Run your text through a grammar linter to check how readable it is.
* Run your text through a grammar [linter](https://en.wikipedia.org/wiki/Lint_(software)) to check how readable it is.
* Tools like Grammarly help you identify grammar issues
* Tools like `Vale` help you identify style issues.
* Tools like `Vale` help you identify style issues. ([This article](https://hackernoon.com/lint-lint-and-away-linters-for-the-english-language-70f4b22cc73c) includes a list of other linter tools.)
* Avoid colloquialisms and jargon because it makes it harder for a non-native English speaker to understand your words.
* Avoid adding your own opinions, or the opinions of others. Doing this clouds a reader's ability to draw conclusions about the discussion.

Expand Down

0 comments on commit cac108c

Please sign in to comment.