Doing Documentation

All

• Use the American dialect of English.
• Maintain consistency, pattern new sections after existing ones.
• This wiki is not perfect from a teaching perspective; the wording is sometimes unhelpful for beginners - help remedy.

ReadMe

• Its purpose is to provide a promotional flyer and getting-started guide.
• Mimic, the well-known "cookiecutter" which provides a great example.

Wiki

• Its purpose is to provide all the documentation that someone wanting to use or contribute pyguby-designer will need.
• For completeness, we repeat some information found in the ReadMe's getting started sections.
• The Table Of Contents to the left should flow naturally for a new user. Imagine them consuming every page, top-down.
• Pages in the wiki should be self-contained and, when not practical, link to other wiki or outside pages. Imagine a practiced user need to refer to one page to brush up on a topic.