Documentation Process - ljramones/trips GitHub Wiki

If you want to help with writing the documentation for TRIPS, you need permission to edit this Wiki.

There are two parts to that:

• You need permission to edit the wiki and
• You need permission to upload images that can be used in the wiki.

Before you do that, make sure you've read the documentation on how the wiki works at the github documentation and how the markdown system works for formatting the pages.

Then, request permission from Larry at the project SLACK discussion in General or Feedback.

Documentation is intended to be used by very unsophisticated users. Please try to avoid jargon where possible and feel free to include images and screenshots to help explain what you mean.

New pages MUST be linked to from a higher page in the wiki. No orphened pages reachable only from the sidebar menu are acceptable. Links are preffered to be fully qualified URLs, so if you're linking to some "new page" the link will be [Link Text](https://github.com/ljramones/trips/wiki/new-page) Please note that spaces in the page title are replaced with dash (-) for the purpose of linking.

When refering to menu choices the preffered formatting is Main Menu Item / Sub Menu Item / Sub Sub menu if there is one -- i.e. Bold, full menu choices listed, seperated by (space)/(space).

Please avoid using ordered (numbered) lists unless it's very important. Unordered (dotted) lists are preffered with the order being implicit. It is acceptable to use single item sub-lists to break out important information

• Main List one
• Main List two
  • Sub list
• Main List three

To create sub lists, indent the line four spaces before typing the *.

Please refer to the program as TRIPS (all upper case) in documentation. If you find places where it's not all upper case, either fix it, or report it in Slack.