Skip to content

Commit

Permalink
documentation-guide: Be concise in “General Considerations” primer.
Browse files Browse the repository at this point in the history
  • Loading branch information
eugeneia committed Feb 11, 2016
1 parent 96a2931 commit 3b9233c
Showing 1 changed file with 0 additions and 4 deletions.
4 changes: 0 additions & 4 deletions src/doc/documentation-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,6 @@ that concatenates the various `README.md` files we have.
## General Considerations

Documentation is most effective when it is precise, concise and uniform.
Documentation is not a novel, or a blog post. It should not be fun to read.
Documentation should be normative, and as such be an especially unsurprising
and bare read. Described below are the cornerstones of boring writing. Embrace
them!

- **Preciseness**. Vague descriptions do more harm than good as different
readers will derive different interpretations. Make sure you use the most
Expand Down

0 comments on commit 3b9233c

Please sign in to comment.