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

Improve collapse/expand track documentation

    Details

    • Type: Task
    • Status: To-Do (View Workflow)
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None
    • Story Points:
      0.5
    • Sprint:
      Fall 8 2021 Nov 29 - Dec 10, Fall 9 2021 Dec 13 - Dec 24, Spring 1 2022 Jan 3 - Jan 14

      Description

      The "collapse/expand track" feature does not appear to be well-documented, even though this can be one of the most confusing features for new IGB users, who often accidentally click the "collapse/expand" button, which collapses the track and makes it look very weird. Because they have no idea how they got into that state, they don't know how to return to the previous state. And if they quit and restart IGB, something many people do with learning a new interface in order to return to a "base state" (recover from an error), it won't work because IGB saves the current configuration of a track and restores the configuration upon restart. The only way to recover from getting stuck in this way is to use the "reset the preferences to default" feature, which new users are unlikely to know about.

      It would be useful to have a single page in the user's guide that explains "collapse/expand" functionality. If we had such a page, we could refer users to it when asked. Also, depending on how well we write this page, it might end up being findable in search engines.

      For this task, write a user's guide page describing the collapse / expand feature for tracks. Make sure you search the user's guide with keyword "collapse" and "expand" to find images others have created that are related to this feature. Re-use them to save time, unless they are not well-down.

      Make the new page of child of this page:

      Additionally, we currently have a very bad explanation of the collapse/expand features on this page:

      Delete this section on "collapse/expand" from the above page.

        Attachments

          Issue Links

            Activity

            ann.loraine Ann Loraine created issue -
            ann.loraine Ann Loraine made changes -
            Field Original Value New Value
            Epic Link IGBF-1765 [ 17855 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            ann.loraine Ann Loraine made changes -
            Description The collapse/expand track feature does not appear to be well-documented, even though this can be one of the most confusing features for new IGB users, who often accidentally click the "collapse/expand" button, which collapses the track and makes it look very weird. Because they have no idea how they got into that state, they don't know how to return to the previous state. And if they quit and restart IGB, something many people do with learning a new interface in order to return to a "base state" (recover from an error), it won't work because IGB saves the current configuration of a track and restores the configuration upon restart. The only way to recover from getting stuck in this way is to reset the preferences to their default, which new users are unlikely to know how to do or even that it can be done.

            It would be useful to have a single page in the user's guide that explains "collapse/expand" functionality. It should be a child of this page:

            * https://wiki.transvar.org/display/igbman/Annotation+tracks

            Also, this location:

            * https://wiki.transvar.org/display/igbman/Customize+track+appearance

            contains a section called "Collapsing and expanding tracks" which is completely unhelpful and needs to be deleted.
            The "collapse/expand track" feature does not appear to be well-documented, even though this can be one of the most confusing features for new IGB users, who often accidentally click the "collapse/expand" button, which collapses the track and makes it look very weird. Because they have no idea how they got into that state, they don't know how to return to the previous state. And if they quit and restart IGB, something many people do with learning a new interface in order to return to a "base state" (recover from an error), it won't work because IGB saves the current configuration of a track and restores the configuration upon restart. The only way to recover from getting stuck in this way is to use the "reset the preferences to default" feature, which new users are unlikely to know about.

            It would be useful to have a single page in the user's guide that explains "collapse/expand" functionality. If we had such a page, we could refer users to it when asked. Also, depending on how well we write this page, it might end up being findable in search engines.

            For this task, write a user's guide page describing the collapse / expand feature for tracks. Make sure you search the user's guide with keyword "collapse" and "expand" to find images others have created that are related to this feature. Re-use them to save time, unless they are not well-down.

            Make the new page of child of this page:

            * https://wiki.transvar.org/display/igbman/Annotation+tracks

            Additionally, we currently have a very bad explanation of the collapse/expand features on this page:

            * https://wiki.transvar.org/display/igbman/Customize+track+appearance

            Delete this section on "collapse/expand" from the above page.
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            ann.loraine Ann Loraine made changes -
            Sprint Fall 7 2021 Nov 8 - Nov 19 [ 133 ] Fall 8 2021 Nov 22 - Dec 3 [ 134 ]
            ann.loraine Ann Loraine made changes -
            Link This issue is blocked by IGBF-3017 [ IGBF-3017 ]
            ann.loraine Ann Loraine made changes -
            Sprint Fall 8 2021 Nov 29 - Dec 10 [ 134 ] Fall 8 2021 Nov 29 - Dec 10, Fall 9 2021 Dec 13 - Dec 24 [ 134, 135 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            ann.loraine Ann Loraine made changes -
            Link This issue is blocked by IGBF-3033 [ IGBF-3033 ]
            ann.loraine Ann Loraine made changes -
            Sprint Fall 8 2021 Nov 29 - Dec 10, Fall 9 2021 Dec 13 - Dec 24 [ 134, 135 ] Fall 8 2021 Nov 29 - Dec 10, Fall 9 2021 Dec 13 - Dec 24, Spring 1 2022 Jan 3 - Jan 14 [ 134, 135, 136 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            ann.loraine Ann Loraine made changes -
            Sprint Fall 8 2021 Nov 29 - Dec 10, Fall 9 2021 Dec 13 - Dec 24, Spring 1 2022 Jan 3 - Jan 14 [ 134, 135, 136 ] Fall 8 2021 Nov 29 - Dec 10, Fall 9 2021 Dec 13 - Dec 24, Spring 1 2022 Jan 3 - Jan 14, Spring 2 2022 Jan 18 - Jan 28 [ 134, 135, 136, 137 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            ann.loraine Ann Loraine made changes -
            Sprint Fall 8 2021 Nov 29 - Dec 10, Fall 9 2021 Dec 13 - Dec 24, Spring 1 2022 Jan 3 - Jan 14, Spring 2 2022 Jan 18 - Jan 28 [ 134, 135, 136, 137 ] Fall 8 2021 Nov 29 - Dec 10, Fall 9 2021 Dec 13 - Dec 24, Spring 1 2022 Jan 3 - Jan 14 [ 134, 135, 136 ]

              People

              • Assignee:
                Unassigned
                Reporter:
                ann.loraine Ann Loraine
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated: