Finalized writing guidelines

This commit is contained in:
Bruno Scheufler
2018-01-30 17:06:52 +01:00
committed by GitHub
parent 9e399e9b9c
commit 1ca3531a8a

View File

@ -1,31 +1,31 @@
# Our content writing manifest
How we boost the learning experience of our readers
How we enhance the reading and learning experience for our visitors
## 1. Simple is better than better
## 1. Simplicity wins
<br/>
making it easy to read and absorb is our mission, we curate content. As such we focus on transforming complex and exhausting topics into a simplified list, trade overloaded information with shortened and less-accurate details, avoid flammable and controversial topics and escape subjective ideas
Making it easy to read and absorb knowledge is our mission, we curate content. As such we focus on transforming complex and exhausting topics into a simplified list, trade overloaded information with shortened and less-accurate details, avoid flammable and controversial topics and escape subjective ideas in favor of generally accepted practices
<br/>
## 2. Evidence based
## 2. Be evidence-based and reliable
<br/>
Our reader should feel great condifence that the content they skims through is reliable. We achieve this by including evidence, references and data. Practically, strive to include quotes from reliable sources, show benchmarks, related design patterns or any scientific measure to prove your claims
Our readers should have great confidence that the content they skim through is reliable. We achieve this by including evidence like references, data and other resources available to this topic. Practically, strive to include quotes from reliable sources, show benchmarks, related design patterns or any scientific measure to prove your claims
## 3. MECE (Mutually Exclusive and Collaboratively Exhausting)
Not only the content is greatly edited and reliable, skimming through it also provides full coverage of the topic. No important sub-topic is left outside
## 3. MECE (Mutually Exclusive and Collectively Exhaustive)
Apart from the content being greatly edited and reliable, skimming through it should also provide full coverage of the topic. No important sub-topic should be left out
## 4. Consistent formatting
The content is presented using fixed templates. Any future content must conform to the same template. If you wish to add new bullets copy a bullet format from an existing bullet. For the additional info please use [this template] (https://github.com/i0natan/nodebestpractices/blob/master/sections/template.md)
The content is presented using fixed templates. Any future content must conform to the same template. If you wish to add new bullets copy a bullet format from an existing bullet and extend it to your needs. For additional information please view [this template](https://github.com/i0natan/nodebestpractices/blob/master/sections/template.md)
## 5. It's About Node.JS
Each advice should be related directly to Node.JS and not to software development in general. When we advise to implement generic pattern/rule in Node.JS, the content should focus on the Node implementation. For example, when we advise to sanitize all requests input for security reasons, Node-lingo should be used - Use Middlewares to sanitize requests input
Each advice should be related directly to Node.JS and not to software development in general. When we advise to implement generic pattern/rule in Node.JS, the content should focus on the Node implementation. For example, when we advise to sanitize all requests input for security reasons, Node-lingo should be used - Use middleware to sanitize request input
## 6. Leading vendors only
Its sometime useful to include names of vendors that can address certain challenges like NPM packages, open source tools or even commercial products. To avoid overwhelming with long lists or recommending non-reputable and stable projects, we came up with the following rules:
Sometimes it's useful to include names of vendors that can address certain challenges and problems like NPM packages, open source tools or even commercial products. To avoid overwhelmingly long lists or recommending non-reputable and unstable projects, we came up with the following rules:
Only the top 3 vendors can be recommended a vendor that appears on the top 3 results in a search engine (Google or GitHub sorted by popularity) for a given relevant keyword can be included in our recommendation.
If its a NPM packages it must also be downloaded at least 750/days on average
If its an open-source project, it must have been updated at least once in the last 6 months
- Only the top 3 vendors should be recommended a vendor that appears in the top 3 results of a search engine (Google or GitHub sorted by popularity) for a given relevant keyword can be included in our recommendation
- If its a NPM package it must also be downloaded at least 750 times a day on average
- If its an open-source project, it must have been updated at least once in the last 6 months