You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

We have three platforms where we discuss or document our annotation work:

  • Slack for discussing vocabulary and reporting issues with the annotation tools
  • Confluence for documenting guidance and reporting vocabulary issues
  • JIRA where issue tickets are logged and development work is tracked




Confluence

Confluence is project collaboration software which links with JIRA.

Who has access

Every Cochrane Information Specialist or other persons who are working on PICO annotation for Cochrane should have access.

How to change your password

If for any reason you need to change your password please follow instructions provided HERE.

Your Space

Each CRG has their own Space in Confluence where they can store any documentation related to their annotation work. On the main page of this Space a form has been provide for reporting vocabulary issues.

Information on how to add new pages or edit existing ones in your Space can be found HERE

Do NOT remove coding from HTML box when editing Space home page

CRGs can add and remove any information as they wish however it is important not to remove the coding in the HTML box as this will disable the reporting form for vocabulary issues.

Block email notifications

Blocking notifications from Confluence

Guidance for using Confluence

Creating a page


ActionDescription
1

Click on Create in the blue menu bar at top of page to create a blank page

2Click on the 3 dots beside Create to open up a list of templates - use only if you want something other than a blank page
3Select the template you wish to use and click on create

4When page is completed click on publish

Editing a page


Action

Description

1Go to Space home page
2Click on Edit at the top of the screen

3Before you can structure your page you need to add a title after which the horizontal edit menu bar will be available

4Vary the page layout. Here you are given options to divide the page into sections, or multiple columns. When you click on the icon a second edit menu bar will appear.

5Insert macros. This is useful if you want to insert table of contents, information boxes etc.


 If you require more information or more advanced options click on  at top of page.

If you have questions or would like some more information added here please contact Deirdre (dbeecher@cochrane.org)

Report a Vocabulary Issue form

Embedded on the home page of each CRG Space, is a vocabulary issue reporting form. Even though the title is Raise Preferred Vocab Term Issue, any vocabulary issue can be raised here, i.e. add a term, merge a term.

Once you have completed the form and clicked on Submit the issue will be logged on JIRA (click HERE for more information).

In each CRG Space, pages have been added with tables for resolved and open vocabulary issues.

As the status of these issues changes these tables automatically update.



Action

Description

1Click on the button provided on your space page.

2Insert the term in the field provided.

3Select the PICO component or components for which the term is required.
4Select the vocabulary action required.Add, Merge, etc.
5Select your Group from the drop-down list.

6Add the CD number of the review.
7

Provide your name and email address. These fields are provided at the bottom of the form.

This helps if we need to contact the person who submitted the request.

8Click on Submit.
9Any information that you might feel relevant to your request should be included in any of the fields provided.


Annotation Knowledge Base

This is a repository for guidance on annotation and can be found HERE.


Back to Top



JIRA 

JIRA is used for project and issue tracking for both vocabulary and tool issues, and tool development.

Who has access

Every Cochrane Information Specialist or other persons who are working on PICO annotation for Cochrane should have access.

LDD and LDO

We have two boards LDD and LDO where we can monitor and track progress of all logged issues.


BoardsFull titleDescription
LDDLinked Data DevelopmentThis board logs tooling related issues such as, ongoing and new development work, bugs, global changes needed for annotation interface etc.
LDOLinked Data OntologyThis board logs vocabulary related issues such as, terms to be added or merged, etc.

Terms requested using the Report a Vocabulary Issue form

Each request generates a JIRA ticket which in turn creates further discussion about individual terms on JIRA. If you are asked for feedback about a vocab request, you will receive an email notification from JIRA. To respond to these messages, click on the JIRA link for the vocab request within the email (rather than responding to the email). You will be prompted to enter your JIRA ID and password. You can then leave comments on the JIRA page for that request. 

Open Vocabulary Issues page shows progress of JIRA tickets. 


StatusDescription
Donethe vocab issue is fixed & ready to use in Live
Ready for Editorshould be fixed very soon
Ready for Developmentnot something we can fix with the editor, but ready for us to pass on to DataLanguage
Solution Identifiedwe could fix it with the editor, but we're waiting for some development from DataLanguage, e.g. there are several vocab requests that will be fixed with LDO 278
Consultationwe have asked one or more Information Specialists for their expertise

Responding to comments on my JIRA ticket term request

Sometimes more information is required from the requester and this is inserted as a comment on the the JIRA ticket that was generated for the specific request. This in turn will generate an email alert to be sent to the requester. To respond we ask that you click on the link to the ticket within the email rather than responding to the email.


ActionImage
1Click on the JIRA ticket link (title of request) within the email that you receive to your email inbox

2

If not already logged in you will be prompted to enter your JIRA/Confluence user ID and password

3

Once logged in click on Comment to leave any further information that was requested by Deirdre or Lorne.

Remember to alert them, insert @ before their names.

When finished click on Add.

Back to Top



Slack

This is a digital work place where you have access to two channels, #annotation and #crg-vocab-vote. We use these channels to post annotation questions, update on new developments, and help everyone with any issue they may have. 

Who has access

Every Cochrane Information Specialist or other persons who are working on PICO annotation for Cochrane should have access to both channels. Please contact the Senior Metadata Specialist if you need access.

What should be posted in the annotation channel?

  • comments & suggestions
  • general questions about annotation issues and vocabularies
  • reporting issues with the tools

Remember that posts in this channel can be viewed by all members.

Working methods

  • Use the Vocab Issues Reporting form which is available via your space in Confluence

  • The Medical Terminology Manager will determine if the issue can be resolved, or if it requires discussion and consensus from the CIS community

  • If discussion and consensus is required, the issue will be posted to the #crg-vocab-vote channel in Slack for comments from the CIS community in the following format:

  • Vocabulary Issue: SNOMED CT has a term for Tonsillectomy and another for Tonsillectomy and Adenoidectomy, but has no  term labeled Adenoidectomy.  Instead, they use the word Adenoidectomy as a synonym for the term that they have labeled Adenoid Excision.
  • Proposed solution:  Change the Cochrane label to Adenoidectomy and make Adenoid Excision the synonym in our vocabulary
  • Response requested: If you agree with the proposed solution or have no opinion, response is optional.  If you disagree or would like further discussion, please comment on this Slack channel within the next 14 days
  • NB - this and any other unresolved vocabulary issues can be found on the Open Vocabulary Issues page in Confluence - where they will be tagged as "Consultation" This issue is LDO-389



The discussion will be open for a two week period after which if no decision has been made it will then be passed to the working group of five.

This working group will vote and come to a decision within one week

Please note that the #annotation channel is still available for all general queries relating to the annotation work, including questions about tools and processes.


Send a private or direct message

If you wish to send a private message to one or more people use the direct message option.

  1. Click on + beside Direct Message at the bottom of the lefthand column
  2. Begin to type name of contact in the search box and the name will arrive at the top of the list beneath the search box
  3. Enter multiple names if you wish to create a group
  4. When ready click on GO

Keyboard functions for formatting messages

The message box either for sending a direct message or posting a message in a channel is not like many other standard text boxes.

  1. use Shift Enter to create new lines in your message

  2. to emphasize words or phrases

    1. surround your text with *asterisks* to create bold text

    2. for italic text use _underscores_ 

    3. for quotes add angle brackets to the beginning of your message to highlight text with an indented blockquote


More information is available at SLACK.

Chat and share your screen 

Please be aware the following funtionality may not work with some browsers.

Icon

Description

At the top of screen, if you see the phone receiver icon, it means you can call the person or persons that you have selected.

Once on a call you can also share your screen by clicking on the screen symbol.



Back to Top
  • No labels