Difference between revisions of "Add a tool to COPTR"
Jump to navigation
Jump to search
Prwheatley (talk | contribs) |
Prwheatley (talk | contribs) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | Contributing to COPTR is easy, but | + | Contributing to COPTR is easy, but if you'd like to see how it's done [https://youtu.be/ITlmx2fwG6s watch this video that explains the process]. |
| + | When you're ready, 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 Types|content type]] and [[Tool Functions|function]], the COPTR entry will be useful. | # 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 Types|content type]] and [[Tool Functions|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. | # 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. | ||
| Line 7: | Line 8: | ||
===Create a new tool entry in COPTR=== | ===Create a new tool entry in COPTR=== | ||
# Create a new tool entry by typing it's name into the box | # Create a new tool entry by typing it's name into the box | ||
| − | # | + | # Avoid adding 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)]] | # 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! | # 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! | Thanks for your contribution! | ||
Latest revision as of 16:45, 3 November 2021
Contributing to COPTR is easy, but if you'd like to see how it's done watch this video that explains the process. When you're ready, 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[edit]
- Create a new tool entry by typing it's name into the box
- Avoid adding 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!
Thanks for your contribution!