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

Improve IGB User's Guide Advanced Search page

    Details

    • Type: Documentation
    • Status: Closed (View Workflow)
    • Priority: Minor
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None

      Description

      Task: Please update the IGB User's Guide Advanced Search page.

      Documentation is confusing and hard to follow in some places. I think more work needs to be done before we move on.

      • The documentation starts talking about the interface, explaining how to do searches. But the only image shown is a picture of the interface with results, after providing instructional text. I think it would help make this less confusing and opaque if the documentation included image(s) with callouts explaining each part of the Advanced Search Tab interface, as it looks when a user first selects it and looks at it.
      • Callouts should be labeled with the names and terms that get used later in the documentation.
      • In later sections, when the Advanced tab's individual functions are discussed, there need to be more images with callouts showing which part of the interface is being used.
      • This statement is nonsensical: "Searching for multiple residues simultaneously" Why would you ever search for just one residue?
      • The term "feature" is used, but it's not clear what this means. It would be better to use terms already part of the IGB interface. IGB's style tabs use the terms "Annotation" and "Graph." Review documentation for the Annotation Tab and other parts of the User's Guide. Make the terminology consistent to avoid confusing and frustrating users.
      • I recommend putting yourself in the shoes of a user who is trying to find out how to do a thing, e.g., how do I find the gene that I'm studying? Or, how do I find that one particular sequence read? Or, how do I find all the instances of a transcription factor binding site of known sequence? If you come to this page knowing very little about the interface, it would likely be very difficult to answer these "how do I...?" questions because the documentation is structured around listing the functions one-by-one, without a lot of context.
      • The end of the documentation contains this text: "More information about regular expressions is available from http://docs.oracle.com/javase/7/docs/index.html." This page does not provide information about regular expressions and how to use them. Instead, it goes to a page titled "Java Platform Standard Edition 7 Documentation". Why are we sending users to this page? There's nothing about regular expressions on this page

        Attachments

          Issue Links

            Activity

            Hide
            pkulzer Paige Kulzer added a comment -

            Here's an overview of what I've done to update the Advanced Search page:

            • I've added a couple of images with callouts to the page, one at the top to outline the terms we use throughout our description of the Advanced Search feature and another one explaining some of the nuances of residue search results (see attached).
            • I've replaced all instances of the word "feature" to be more specific (i.e., "annotation" or "sequence") and hopefully less confusing.
            • I removed the section titled "Searching for multiple residues simultaneously". This section simply outlined how to use the pipe ( | ) in residue searches, so I added a row to the regex table detailing how to use the pipe instead.
            • I added an outline to the Keyword Searches section that walks a user through how to do a keyword search. This now matches the other two search-related sections that were already outlining how to do residue and name searches.
            • I updated the link at the bottom of the page to point users towards a regex cheat sheet (https://www.jrebel.com/blog/java-regular-expressions-cheat-sheet).

            For review:

            • Would you like more images with callouts? I.e., are all key terms used on this page visually outlined for a user to see?
            • Does the link at the bottom of the page take you to the correct regex website?
            • Have I removed all instances of confusing wording such as "feature"?

            Question:

            • The Properties search option has not been outlined in the documentation. How does it differ from the Keyword search option and should it be added to this page?
            Show
            pkulzer Paige Kulzer added a comment - Here's an overview of what I've done to update the Advanced Search page: I've added a couple of images with callouts to the page, one at the top to outline the terms we use throughout our description of the Advanced Search feature and another one explaining some of the nuances of residue search results (see attached). I've replaced all instances of the word "feature" to be more specific (i.e., "annotation" or "sequence") and hopefully less confusing. I removed the section titled "Searching for multiple residues simultaneously". This section simply outlined how to use the pipe ( | ) in residue searches, so I added a row to the regex table detailing how to use the pipe instead. I added an outline to the Keyword Searches section that walks a user through how to do a keyword search. This now matches the other two search-related sections that were already outlining how to do residue and name searches. I updated the link at the bottom of the page to point users towards a regex cheat sheet ( https://www.jrebel.com/blog/java-regular-expressions-cheat-sheet ). For review: Would you like more images with callouts? I.e., are all key terms used on this page visually outlined for a user to see? Does the link at the bottom of the page take you to the correct regex website? Have I removed all instances of confusing wording such as "feature"? Question: The Properties search option has not been outlined in the documentation. How does it differ from the Keyword search option and should it be added to this page?
            Hide
            nfreese Nowlan Freese added a comment -
            • The first image is too wide. Make your IGB window smaller when creating images.
            • Add section for "In" menu describing the difference.
              • Also important to point out that search only works if the data are loaded. I.e. if I have loaded my annotation data for chr1 but do a search for a gene on chr2 (assuming chr2 data has not been loaded), then no results will be returned. This has tricked users in the past.
            • Include Properties as a search type. I'm not sure how it is distinguished from other search types, but let's just include it for now and we will figure it out later.
            • The "In" and "For" capitalization is inconsistent. Probably stick with all lowercase to match IGB.
            • This image is too wide.
            • I would move the callouts in this image. The plus/minus callout lines seem to be pointing at the same thing. I think moving the callouts outside of the IGB image would also help them stand out.
            • There's a bit of text towards the bottom "Residues Search Results" that doesn't seem to be part of any section?
            Show
            nfreese Nowlan Freese added a comment - The first image is too wide. Make your IGB window smaller when creating images. Add section for "In" menu describing the difference. Also important to point out that search only works if the data are loaded. I.e. if I have loaded my annotation data for chr1 but do a search for a gene on chr2 (assuming chr2 data has not been loaded), then no results will be returned. This has tricked users in the past. Include Properties as a search type. I'm not sure how it is distinguished from other search types, but let's just include it for now and we will figure it out later. The "In" and "For" capitalization is inconsistent. Probably stick with all lowercase to match IGB. This image is too wide. I would move the callouts in this image . The plus/minus callout lines seem to be pointing at the same thing. I think moving the callouts outside of the IGB image would also help them stand out. There's a bit of text towards the bottom "Residues Search Results" that doesn't seem to be part of any section?
            Hide
            pkulzer Paige Kulzer added a comment -

            Here are the changes I made to address your comments:

            • Downsized the images that were too wide
            • Moved callouts on the last image so that they're easier to read/follow
            • Added two sections (Advanced Search tab and Search by Properties). In the Advanced Search tab section, I added information about the "in" menu as well as a note regarding the need to load data before conducting searches. In the Search by Properties section, I added some details about what I believe that search to be (i.e., a combo of the Keyword and Title searches) and added in an image of an example Properties search.
            • I cropped the final image so that the text reading "Residues Search Results" doesn't look so out of place.

            Let me know what you think!

            Show
            pkulzer Paige Kulzer added a comment - Here are the changes I made to address your comments: Downsized the images that were too wide Moved callouts on the last image so that they're easier to read/follow Added two sections (Advanced Search tab and Search by Properties). In the Advanced Search tab section, I added information about the "in" menu as well as a note regarding the need to load data before conducting searches. In the Search by Properties section, I added some details about what I believe that search to be (i.e., a combo of the Keyword and Title searches) and added in an image of an example Properties search. I cropped the final image so that the text reading "Residues Search Results" doesn't look so out of place. Let me know what you think!
            Hide
            nfreese Nowlan Freese added a comment -

            Organize the Search types so that they are the same order as presented in IGB: Properties, Keyword, ID Name or Title, Residues. Disregard this if the menu is random (some menus in IGB are random).
            Images are still too big for me. I have attached some examples.

            Show
            nfreese Nowlan Freese added a comment - Organize the Search types so that they are the same order as presented in IGB: Properties, Keyword, ID Name or Title, Residues. Disregard this if the menu is random (some menus in IGB are random). Images are still too big for me. I have attached some examples.
            Hide
            pkulzer Paige Kulzer added a comment -

            I updated several of the images to further reduce image sizes and improve readability to try and match the examples you provided. I also re-ordered the "Search by" sections to match the order of the Search drop-down in IGB.

            Ready for review!

            Show
            pkulzer Paige Kulzer added a comment - I updated several of the images to further reduce image sizes and improve readability to try and match the examples you provided. I also re-ordered the "Search by" sections to match the order of the Search drop-down in IGB. Ready for review!
            Hide
            nfreese Nowlan Freese added a comment -

            This image has too much empty space in the middle. Use this image or similar.

            Other images look good.

            Show
            nfreese Nowlan Freese added a comment - This image has too much empty space in the middle. Use this image or similar. Other images look good.
            Hide
            pkulzer Paige Kulzer added a comment -
            • I updated that image to reduce the amount of empty white space.
            • I also went ahead and increased the font size of the callouts a bit more.
            • All images used to update this page has been saved in Dropbox (e.g., /Users/pkulzer/Dropbox/IGB Users Guide Art and Style Info/AdvancedSearch/Images/).
            • I have also compiled the images used on this page into a powerpoint document and placed it in Dropbox along the same file path.

            Ready for one final review!

            Show
            pkulzer Paige Kulzer added a comment - I updated that image to reduce the amount of empty white space. I also went ahead and increased the font size of the callouts a bit more. All images used to update this page has been saved in Dropbox (e.g., /Users/pkulzer/Dropbox/IGB Users Guide Art and Style Info/AdvancedSearch/Images/). I have also compiled the images used on this page into a powerpoint document and placed it in Dropbox along the same file path. Ready for one final review!
            Hide
            nfreese Nowlan Freese added a comment -

            Images look good.
            Images are located in Dropbox > IGB Users Guide Art and Style Info > AdvancedSearch

            Closing ticket.

            Show
            nfreese Nowlan Freese added a comment - Images look good. Images are located in Dropbox > IGB Users Guide Art and Style Info > AdvancedSearch Closing ticket.

              People

              • Assignee:
                pkulzer Paige Kulzer
                Reporter:
                nfreese Nowlan Freese
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: