Details
-
Type: Documentation
-
Status: Closed (View Workflow)
-
Priority: Minor
-
Resolution: Done
-
Affects Version/s: None
-
Fix Version/s: None
-
Labels:None
-
Story Points:2
-
Epic Link:
-
Sprint:Spring 6, Spring 7
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
Nowlan Freese
created issue -
Nowlan Freese
made changes -
Field | Original Value | New Value |
---|---|---|
Epic Link | IGBF-1765 [ 17855 ] |
Nowlan Freese
made changes -
Ann Loraine
made changes -
Sprint | Fall 1 2023 Sep 5 [ 178 ] | Fall 1 - Sep [ 82 ] |
Ann Loraine
made changes -
Rank | Ranked higher |
Nowlan Freese
made changes -
Sprint | Fall 1 - Sep 5 [ 82 ] |
Paige Kulzer
made changes -
Assignee | Paige Kulzer [ pkulzer ] |
Paige Kulzer
made changes -
Sprint | Spring 6 [ 190 ] |
Paige Kulzer
made changes -
Status | To-Do [ 10305 ] | In Progress [ 3 ] |
Paige Kulzer
made changes -
Attachment | AdvancedSearchTab_Callouts2.png [ 18295 ] | |
Attachment | AdvancedSearchTab_Callouts.png [ 18296 ] |
Paige Kulzer
made changes -
Status | In Progress [ 3 ] | Needs 1st Level Review [ 10005 ] |
Paige Kulzer
made changes -
Assignee | Paige Kulzer [ pkulzer ] | Nowlan Freese [ nfreese ] |
Paige Kulzer
made changes -
Nowlan Freese
made changes -
Status | Needs 1st Level Review [ 10005 ] | First Level Review in Progress [ 10301 ] |
Nowlan Freese
made changes -
Assignee | Nowlan Freese [ nfreese ] | Paige Kulzer [ pkulzer ] |
Nowlan Freese
made changes -
Status | First Level Review in Progress [ 10301 ] | To-Do [ 10305 ] |
Paige Kulzer
made changes -
Status | To-Do [ 10305 ] | In Progress [ 3 ] |
Paige Kulzer
made changes -
Status | In Progress [ 3 ] | Needs 1st Level Review [ 10005 ] |
Paige Kulzer
made changes -
Assignee | Paige Kulzer [ pkulzer ] | Nowlan Freese [ nfreese ] |
Nowlan Freese
made changes -
Status | Needs 1st Level Review [ 10005 ] | First Level Review in Progress [ 10301 ] |
Nowlan Freese
made changes -
Attachment | Screenshot 2024-03-28 at 2.57.38 PM.png [ 18308 ] | |
Attachment | Screenshot 2024-03-28 at 2.55.04 PM.png [ 18309 ] |
Nowlan Freese
made changes -
Assignee | Nowlan Freese [ nfreese ] | Paige Kulzer [ pkulzer ] |
Nowlan Freese
made changes -
Status | First Level Review in Progress [ 10301 ] | To-Do [ 10305 ] |
Paige Kulzer
made changes -
Status | To-Do [ 10305 ] | In Progress [ 3 ] |
Paige Kulzer
made changes -
Status | In Progress [ 3 ] | Needs 1st Level Review [ 10005 ] |
Paige Kulzer
made changes -
Assignee | Paige Kulzer [ pkulzer ] | Nowlan Freese [ nfreese ] |
Ann Loraine
made changes -
Sprint | Spring 6 [ 190 ] | Spring 6, Spring 7 [ 190, 191 ] |
Ann Loraine
made changes -
Rank | Ranked higher |
Nowlan Freese
made changes -
Status | Needs 1st Level Review [ 10005 ] | First Level Review in Progress [ 10301 ] |
Nowlan Freese
made changes -
Assignee | Nowlan Freese [ nfreese ] | Paige Kulzer [ pkulzer ] |
Nowlan Freese
made changes -
Status | First Level Review in Progress [ 10301 ] | To-Do [ 10305 ] |
Paige Kulzer
made changes -
Status | To-Do [ 10305 ] | In Progress [ 3 ] |
Paige Kulzer
made changes -
Status | In Progress [ 3 ] | Needs 1st Level Review [ 10005 ] |
Paige Kulzer
made changes -
Assignee | Paige Kulzer [ pkulzer ] | Nowlan Freese [ nfreese ] |
Nowlan Freese
made changes -
Status | Needs 1st Level Review [ 10005 ] | First Level Review in Progress [ 10301 ] |
Nowlan Freese
made changes -
Assignee | Nowlan Freese [ nfreese ] | Paige Kulzer [ pkulzer ] |
Nowlan Freese
made changes -
Status | First Level Review in Progress [ 10301 ] | Ready for Pull Request [ 10304 ] |
Nowlan Freese
made changes -
Status | Ready for Pull Request [ 10304 ] | Pull Request Submitted [ 10101 ] |
Nowlan Freese
made changes -
Status | Pull Request Submitted [ 10101 ] | Reviewing Pull Request [ 10303 ] |
Nowlan Freese
made changes -
Status | Reviewing Pull Request [ 10303 ] | Merged Needs Testing [ 10002 ] |
Nowlan Freese
made changes -
Status | Merged Needs Testing [ 10002 ] | Post-merge Testing In Progress [ 10003 ] |
Nowlan Freese
made changes -
Resolution | Done [ 10000 ] | |
Status | Post-merge Testing In Progress [ 10003 ] | Closed [ 6 ] |
Here's an overview of what I've done to update the Advanced Search page:
For review:
Question: