Difference between revisions of "Guidelines for contributing to COPTR"

From COPTR
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
* This site uses [https://www.mediawiki.org/wiki/Help:Formatting MediaWiki formatting].
 
* This site uses [https://www.mediawiki.org/wiki/Help:Formatting MediaWiki formatting].
 +
* The name of a tool entry page should take the form of Acronym (in capitals) and then the full name in brackets. Eg: [[ACE (Audit Control Environment)]]
 
* Keep COPTR entries concise and factual. User feedback and other subjective comment should go elsewhere (eg. a blog post) and be referenced with a hotlink from the "User Experiences" section.
 
* Keep COPTR entries concise and factual. User feedback and other subjective comment should go elsewhere (eg. a blog post) and be referenced with a hotlink from the "User Experiences" section.
 
* Avoid time specific language as it will quickly become out of date. For example avoid: "The current version of the tool...", "This is a new tool", "This tool is currently under development". Try instead to be specific and reference a particular tool version and/or date.
 
* Avoid time specific language as it will quickly become out of date. For example avoid: "The current version of the tool...", "This is a new tool", "This tool is currently under development". Try instead to be specific and reference a particular tool version and/or date.
 
* Choose categories (tags) for a new tool page carefully. Make use of existing categories and avoid adding lots of unnecessary tags.
 
* Choose categories (tags) for a new tool page carefully. Make use of existing categories and avoid adding lots of unnecessary tags.
 +
* Save early, save often, avoid time outs and loss of your edits!
 
* Search carefully for existing entries before adding a new tool entry. Ensure you don't add a duplicate entry by first searching for existing entries for the tool you want to add. If there is already an entry, make it better!
 
* Search carefully for existing entries before adding a new tool entry. Ensure you don't add a duplicate entry by first searching for existing entries for the tool you want to add. If there is already an entry, make it better!
 
* Please don't change the structure of your new tool entry, as this will damage export from COPTR. If you have feedback on the existing structure, please let us know.
 
* Please don't change the structure of your new tool entry, as this will damage export from COPTR. If you have feedback on the existing structure, please let us know.
 +
* Can I add (or update) a tool entry about my own tool in COPTR? Yes - keep it factual, but otherwise that would be very helpful, thanks.
 
* Check out this [http://vimeo.com/107879014 video that describes what COPTR is and how you can contribute to it], courtesy of [http://www.unt.edu/ UNT].
 
* Check out this [http://vimeo.com/107879014 video that describes what COPTR is and how you can contribute to it], courtesy of [http://www.unt.edu/ UNT].

Latest revision as of 15:54, 21 September 2018

  • This site uses MediaWiki formatting.
  • The name of a tool entry page should take the form of Acronym (in capitals) and then the full name in brackets. Eg: ACE (Audit Control Environment)
  • Keep COPTR entries concise and factual. User feedback and other subjective comment should go elsewhere (eg. a blog post) and be referenced with a hotlink from the "User Experiences" section.
  • Avoid time specific language as it will quickly become out of date. For example avoid: "The current version of the tool...", "This is a new tool", "This tool is currently under development". Try instead to be specific and reference a particular tool version and/or date.
  • Choose categories (tags) for a new tool page carefully. Make use of existing categories and avoid adding lots of unnecessary tags.
  • Save early, save often, avoid time outs and loss of your edits!
  • Search carefully for existing entries before adding a new tool entry. Ensure you don't add a duplicate entry by first searching for existing entries for the tool you want to add. If there is already an entry, make it better!
  • Please don't change the structure of your new tool entry, as this will damage export from COPTR. If you have feedback on the existing structure, please let us know.
  • Can I add (or update) a tool entry about my own tool in COPTR? Yes - keep it factual, but otherwise that would be very helpful, thanks.
  • Check out this video that describes what COPTR is and how you can contribute to it, courtesy of UNT.