kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-09-14 16:13:57 +00:00
Code Issues Projects Releases Wiki Activity

Updated Documentation HowTo (markdown)

E:V:A
2018-03-16 10:39:56 +02:00
parent 70ce7aaef4
commit 7adea464d4
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
Documentation-HowTo.md

@@ -13,22 +13,22 @@ It's in no way meant to be exhaustive, but it will surely make sure to relieve y
* **Don't assume any previous knowledge!**
This is by far, the number one doc issue and failure!
* **Does the software depend on any other, previously installed software?**
* **Does the software depend on any other, previously installed software?**
* `If so make sure to either re-iterate the steps or link to equivalently good installation instructions.`
* `Specify exactly what it depend on, and where to find it.`
* **Are the steps following a logical order of operations?**
* **Are the steps following a logical order of operations?**
You'll be surprised!
* **Is the information you give, correct?**
* **Is the information you give, correct?**
Don't guess how things work!
* **Are all the steps up-to-date with current master repository code and functionality?**
This is the hardest to keep up, since most SW in github are under some development.
* **Are your screenshots up-to-date with how the UI actually look?**
* **Are your screenshots up-to-date with how the UI actually look?**
You have screenshots, right!? A million of your words, could never replace them.
* **Have you started from scratch and followed your own installation instructions?**
* **Have you started from scratch and followed your own installation instructions?**
This step is what fails 99.9% of all documentation. Unfortunately developers are incredibly lazy in this regard, since they think it's a waste of time. I'm sure NASA has something to teach you about this.
* **Can anyone complete the steps successfully?**
Can your 6 year old baby sister or grandma follow the steps without asking for help?
* **Can anyone raise a question in the github issues?**
* **Can anyone raise a question in the github issues?**
* Are you going to answer respectfully, short and concise and point the user to where to find the information, and take into consideration that perhaps something is not clear from your documentation and need more attention. (Perhaps the UI, a dependency or link has changed?)
* Or are you going to be a cocky ass and give degrading comments?