Home
This is my documentation site.
It also has posts.
The documentation is a work in progress, but broadly the ideas are:
- Examples are good.
- Commands should start chronologically, so
git init
should be covered beforegit stash
. - Where possible, docs should read like a well-commented script, so simply plugging in the commands should always do something.
- Better to repeat a statement, than to link to another document.
- Documentation should not explain the program (if you want to use it, you know what it does).