Difference between revisions of "Add a tool to COPTR"

From COPTR
Jump to navigation Jump to search
Line 1: Line 1:
−
To add a tool to COPTR, type it's name into the box and make sure you follow the guidelines below. Thanks for your contribution!
+
Contributing to COPTR is easy, but before you start, follow these tips:
 +
# Check out one or two existing tool entries first, so you know what to aim for. [[DROID]] has a detailed entry on COPTR. [[Pre-Ingest Tool]] has a minimal entry (in wiki terms this is known as a stub). As long as a tool has a Purpose (a one sentence description of its function) and has been categorised by content type and function, the COPTR entry will be useful.
 +
# 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.
 +
# 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.
 +
 
 +
===Create a new tool entry in COPTR===
 +
# Create a new tool entry by typing it's name into the box
 +
# 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!
 +
# 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)]]
 +
# Save early, save often, avoid time outs and loss of your edits!
 
{{#forminput:form=Tool|placeholder=Enter the title of the new tool here|button text=Create Tool}}
 
{{#forminput:form=Tool|placeholder=Enter the title of the new tool here|button text=Create Tool}}
−
 
+
Thanks for your contribution!
−
* 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!
 
−
* 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.
 
−
* Save early, save often, avoid time outs and loss of your edits!
 
−
* 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.
 

Revision as of 08:47, 13 May 2021

Contributing to COPTR is easy, but before you start, follow these tips:

  1. Check out one or two existing tool entries first, so you know what to aim for. DROID has a detailed entry on COPTR. Pre-Ingest Tool has a minimal entry (in wiki terms this is known as a stub). As long as a tool has a Purpose (a one sentence description of its function) and has been categorised by content type and function, the COPTR entry will be useful.
  2. 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.
  3. 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.
  4. 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.

Create a new tool entry in COPTR

  1. Create a new tool entry by typing it's name into the box
  2. 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!
  3. 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)
  4. Save early, save often, avoid time outs and loss of your edits!

Thanks for your contribution!

Retrieved from ‘https://coptr.digipres.org/index.php?title=Add_a_tool_to_COPTR&oldid=4865’