Uploaded image for project: 'IGB'
  1. IGB
  2. IGBF-2526

Create new user guide page in Annotation Tracks

    Details

    • Type: Task
    • Status: Closed (View Workflow)
    • Priority: Minor
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
    • Story Points:
      1.5
    • Sprint:
      Fall 1: 14 Sep - 25 Sep, Fall 2: 28 Sep - 9 Oct, Fall 3: Oct 12 - Oct 23, Fall 4 Oct 26 - Nov 6, Fall 5 Nov 9 - Nov 20, Fall 6 Nov 30 - Dec 11, Fall 7 Dec 14 - Dec 23, Winter 1 Dec 28 - Jan 8, Winter 2 Jan 11 - Jan 22, Winter 3 Jan 25 - Feb 5, Winter 4 Feb 8 - Feb 19

      Description

      Create a new page in the Annotation Tracks section for the "Filter By" option.
      The “Color By..“ option is explained in its own section, and the same thing should be done for the “Filter..” option.

      Page in need of editing:
      https://wiki.transvar.org/display/igbman/Annotation+tracks

      Follow writing and graphic art guidelines described here:
      https://www.dropbox.com/sh/5e0sblqc54al9wb/AACrW-5xgLCpOYuT9-ltvxuna?dl=0

        Attachments

          Issue Links

            Activity

            Hide
            nfreese Nowlan Freese added a comment -
            Show
            nfreese Nowlan Freese added a comment - Created a new page for Filter: https://wiki.transvar.org/display/igbman/Filter+annotation+data
            Hide
            ann.loraine Ann Loraine added a comment -

            Recommendations:

            • Change first sentence to explain what is meant by "filter". Users need to know what this feature actually does right off the bat so that they will know whether they need to keep reading or move on to another page to find the functionality they are looking for. Filtering in this context means: hiding or showing things based on their attributes, such as whether or not reads have gaps. This first sentence is the "lede" which ought to summarize in a descriptive way what the feature is doing and why it could be useful. But of course, it needs to also be brief.
            • The image helps and is great, but it is also a bit confusing because a new user might see this and have no idea what they are looking at. Explanatory call-outs and a legend could help a ton. I would recommend making a figure containing two images - one with filtering turned on and another with filtering turned off. Call-outs can point out the filter mark, which is otherwise very cryptic.
            • When showing images in the user's guide, I would like for us to explain to readers how they can reproduce the image. To do this, let's create figure legends that have a two-part structure: First part explains what the image is showing and the second part explains how the image was created, using language reminiscent of the figure legend from a well-written research article.
            • The callout lines point out components of the interface in the later figures are a lot thicker than on other pages. Also there is a thicker black border around the images that does not appear for images on other pages. It would be good to have a consistent appearance throughout the user's guide.
            • If you have not already done so, do please add the content to the Dropbox folder "IGB Users Guide Art and Style info"
            Show
            ann.loraine Ann Loraine added a comment - Recommendations: Change first sentence to explain what is meant by "filter". Users need to know what this feature actually does right off the bat so that they will know whether they need to keep reading or move on to another page to find the functionality they are looking for. Filtering in this context means: hiding or showing things based on their attributes, such as whether or not reads have gaps. This first sentence is the "lede" which ought to summarize in a descriptive way what the feature is doing and why it could be useful. But of course, it needs to also be brief. The image helps and is great, but it is also a bit confusing because a new user might see this and have no idea what they are looking at. Explanatory call-outs and a legend could help a ton. I would recommend making a figure containing two images - one with filtering turned on and another with filtering turned off. Call-outs can point out the filter mark, which is otherwise very cryptic. When showing images in the user's guide, I would like for us to explain to readers how they can reproduce the image. To do this, let's create figure legends that have a two-part structure: First part explains what the image is showing and the second part explains how the image was created, using language reminiscent of the figure legend from a well-written research article. The callout lines point out components of the interface in the later figures are a lot thicker than on other pages. Also there is a thicker black border around the images that does not appear for images on other pages. It would be good to have a consistent appearance throughout the user's guide. If you have not already done so, do please add the content to the Dropbox folder "IGB Users Guide Art and Style info"
            Hide
            nfreese Nowlan Freese added a comment - - edited

            I changed the first sentence based on the above recommendation.

            I added a before filtered image.

            I added a section on how to reproduce the top images.

            I reformatted all of the images so that they would be more consistent.

            Two issues:
            I created an image with figure legends that described how to replicate the image. However, I found it to be not as useful as a full description. I could not find a way to add a figure legend within confluence so I tried adding the figure legend as part of the image itself. However, this meant that the text could not be copied or searched, which I found undesirable.

            I do not have access to the Dropbox folder "IGB Users Guide Art and Style info" through the Loraine Lab UNCC (lorainelabuncc@gmail.com) Dropbox account. When I click on this link it informs me that I need to add it to my Dropbox account and ask for access. I think it would be much easier if we created a Google Drive folder for the User's Guide. This would make it easier to control who has access and we can use the Google Slides to directly create figures. We can then include the link to the specific slide in the Jira issue.

            Show
            nfreese Nowlan Freese added a comment - - edited I changed the first sentence based on the above recommendation. I added a before filtered image. I added a section on how to reproduce the top images. I reformatted all of the images so that they would be more consistent. Two issues: I created an image with figure legends that described how to replicate the image. However, I found it to be not as useful as a full description. I could not find a way to add a figure legend within confluence so I tried adding the figure legend as part of the image itself. However, this meant that the text could not be copied or searched, which I found undesirable. I do not have access to the Dropbox folder "IGB Users Guide Art and Style info" through the Loraine Lab UNCC (lorainelabuncc@gmail.com) Dropbox account. When I click on this link it informs me that I need to add it to my Dropbox account and ask for access. I think it would be much easier if we created a Google Drive folder for the User's Guide. This would make it easier to control who has access and we can use the Google Slides to directly create figures. We can then include the link to the specific slide in the Jira issue.
            Hide
            nfreese Nowlan Freese added a comment -

            Powerpoint slides with images has been placed in the Dropbox folder "IGB Users Guide Art and Style info".

            Show
            nfreese Nowlan Freese added a comment - Powerpoint slides with images has been placed in the Dropbox folder "IGB Users Guide Art and Style info".

              People

              • Assignee:
                nfreese Nowlan Freese
                Reporter:
                ssegu Sai Supreeth Segu (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: