Uploaded image for project: 'Deep Backlog'
  1. Deep Backlog
  2. DB-197

Expunge subjective terms from the User's Guide such as "easy", "fast", "fun", etc.

    Details

    • Type: Task
    • Status: Open (View Workflow)
    • Priority: Major
    • Resolution: Unresolved
    • Labels:
      None

      Description

      To use a consistent voice in the IGB User's Guide the IGB team has decided to follow the guidelines outlined in the Microsoft Manual of Style.

      On page 5 in the manual it says that we should not minimize complexity and avoid overusing subjective terms such as easy, fast, fun, and so on because if we say something is easy and it is hard then we run the risk of alienating them.

      Review the comments below for places where these subjective terms may be used in our user's guide to determine if we should use different wording.

        Attachments

          Activity

          mason Mason Meyer (Inactive) created issue -
          mason Mason Meyer (Inactive) made changes -
          Field Original Value New Value
          Epic Link IGBF-140 [ 14594 ]
          mason Mason Meyer (Inactive) made changes -
          Rank Ranked higher
          Hide
          mason Mason Meyer (Inactive) added a comment -

          https://wiki.transvar.org/display/igbman/Set+up+a+Quickload+in+Dropbox
          The page above contains a sentence that reads, "The file hosting service Dropbox provides IGB users a QUICK and EASY way to share IGB Quickload sites with their colleagues and collaborators over the cloud."

          We may want to just say, "...provides users a way..."

          Show
          mason Mason Meyer (Inactive) added a comment - https://wiki.transvar.org/display/igbman/Set+up+a+Quickload+in+Dropbox The page above contains a sentence that reads, "The file hosting service Dropbox provides IGB users a QUICK and EASY way to share IGB Quickload sites with their colleagues and collaborators over the cloud." We may want to just say, "...provides users a way..."
          Hide
          mason Mason Meyer (Inactive) added a comment - - edited

          https://wiki.transvar.org/display/igbman/Tabbed+panels
          The page above contains a sentence that reads, "IGB tabbed panels provide an EASY-TO-USE way to access multiple functions."

          We may want to change the wording of this sentence.

          Show
          mason Mason Meyer (Inactive) added a comment - - edited https://wiki.transvar.org/display/igbman/Tabbed+panels The page above contains a sentence that reads, "IGB tabbed panels provide an EASY-TO-USE way to access multiple functions." We may want to change the wording of this sentence.
          Hide
          mason Mason Meyer (Inactive) added a comment -

          https://wiki.transvar.org/display/igbman/Edge+matching+ESTs+to+assess+alternative+splicing
          The page above contains a sentence that reads, "Edge matching is a specialized visualization technique for genomics data that makes it EASY to compare boundaries."

          We may want to change this to, "Edge matching is a visualization technique for genomics data that helps you compare boundaries."

          Notice that I also removed the word "specialized" in the recommended sentence above because I feel that it may be unnecessary.

          Show
          mason Mason Meyer (Inactive) added a comment - https://wiki.transvar.org/display/igbman/Edge+matching+ESTs+to+assess+alternative+splicing The page above contains a sentence that reads, "Edge matching is a specialized visualization technique for genomics data that makes it EASY to compare boundaries." We may want to change this to, "Edge matching is a visualization technique for genomics data that helps you compare boundaries." Notice that I also removed the word "specialized" in the recommended sentence above because I feel that it may be unnecessary.
          Hide
          mason Mason Meyer (Inactive) added a comment -

          https://wiki.transvar.org/display/igbman/Zooming+and+panning+the+display
          The page above contains a sentence that reads, "To make it EASY for you to move through a genome, IGB implements a visualization technique called animated one-dimensional semantic zooming."

          We may want to change this to something like, "IGB uses a visualization technique called animated one-dimensional semantic zooming for moving through a genome."

          Show
          mason Mason Meyer (Inactive) added a comment - https://wiki.transvar.org/display/igbman/Zooming+and+panning+the+display The page above contains a sentence that reads, "To make it EASY for you to move through a genome, IGB implements a visualization technique called animated one-dimensional semantic zooming." We may want to change this to something like, "IGB uses a visualization technique called animated one-dimensional semantic zooming for moving through a genome."
          Hide
          mason Mason Meyer (Inactive) added a comment -

          https://jira.transvar.org/browse/IGBF-588
          The page above contains a sentence that reads, "It is EASY to add new genome versions to IGBQuickLoad.org."

          We may want to think about ways to reword this sentence or that paragraph that it resides in.

          Show
          mason Mason Meyer (Inactive) added a comment - https://jira.transvar.org/browse/IGBF-588 The page above contains a sentence that reads, "It is EASY to add new genome versions to IGBQuickLoad.org." We may want to think about ways to reword this sentence or that paragraph that it resides in.
          Hide
          mason Mason Meyer (Inactive) added a comment -

          https://wiki.transvar.org/display/igbman/Bookmarks
          The page above contains a sentence that reads, "The Bookmark tab allows you EASY access to the bookmark list and provides tools for managing and sharing bookmarks."

          We may want to change this sentence to, "The Bookmark tab allows access to the bookmark list and provides tools for managing and sharing bookmarks."

          Show
          mason Mason Meyer (Inactive) added a comment - https://wiki.transvar.org/display/igbman/Bookmarks The page above contains a sentence that reads, "The Bookmark tab allows you EASY access to the bookmark list and provides tools for managing and sharing bookmarks." We may want to change this sentence to, "The Bookmark tab allows access to the bookmark list and provides tools for managing and sharing bookmarks."
          Hide
          mason Mason Meyer (Inactive) added a comment -

          https://wiki.transvar.org/display/igbman/Advanced+Graph+Manipulation
          The page above contains a sentence that reads, "Here, data from several experiments at different times during the development of an organism are shown together in a single track, and it is EASY to see that expression of genes is being regulated over time."

          We may want to change this to, "Here, data from several experiments at different times during the development of an organism are shown together in a single track to help show that expression of genes is being regulated over time."

          Show
          mason Mason Meyer (Inactive) added a comment - https://wiki.transvar.org/display/igbman/Advanced+Graph+Manipulation The page above contains a sentence that reads, "Here, data from several experiments at different times during the development of an organism are shown together in a single track, and it is EASY to see that expression of genes is being regulated over time." We may want to change this to, "Here, data from several experiments at different times during the development of an organism are shown together in a single track to help show that expression of genes is being regulated over time."
          Hide
          mason Mason Meyer (Inactive) added a comment -

          https://wiki.transvar.org/display/igbman/View+a+bacterial+genome+in+IGB
          The page above contains a sentence that reads, "Just that EASY!"

          We may be able to remove this sentence.

          Show
          mason Mason Meyer (Inactive) added a comment - https://wiki.transvar.org/display/igbman/View+a+bacterial+genome+in+IGB The page above contains a sentence that reads, "Just that EASY!" We may be able to remove this sentence.
          Hide
          mason Mason Meyer (Inactive) added a comment -

          https://wiki.transvar.org/display/igbman/Controlling+IGB+using+IGB+Links
          The page above contains a sentence that reads, "By clicking links in an IGB links page, you can QUICKLY move to a new region."

          We may be able to change this to, "You can move to a new region by clicking links in an IGB links page."

          Show
          mason Mason Meyer (Inactive) added a comment - https://wiki.transvar.org/display/igbman/Controlling+IGB+using+IGB+Links The page above contains a sentence that reads, "By clicking links in an IGB links page, you can QUICKLY move to a new region." We may be able to change this to, "You can move to a new region by clicking links in an IGB links page."
          Hide
          mason Mason Meyer (Inactive) added a comment -

          https://wiki.transvar.org/display/igbman/RNA-Seq+Coverage+graphs+-+Visualizing+data+from+maize+reproductive+transcriptomes
          The page above contains a sentence that reads, "Tip: To navigate QUICKLY to the regions shown below, enter the regions (as shown) in the upper left text box and press the Return key on your keyboard."

          We may just want to remove the word "quickly" from the sentence.

          Show
          mason Mason Meyer (Inactive) added a comment - https://wiki.transvar.org/display/igbman/RNA-Seq+Coverage+graphs+-+Visualizing+data+from+maize+reproductive+transcriptomes The page above contains a sentence that reads, "Tip: To navigate QUICKLY to the regions shown below, enter the regions (as shown) in the upper left text box and press the Return key on your keyboard." We may just want to remove the word "quickly" from the sentence.
          Hide
          mason Mason Meyer (Inactive) added a comment -

          https://wiki.transvar.org/display/igbman/Home
          The page above contains a sentence that reads, "In IGB, zooming is animated, allowing you to EASILY and QUICKLY adjust the zoom level as needed."

          We may want to change this to, "In IGB, zooming is animated, helping you adjust the zoom level as needed."

          Show
          mason Mason Meyer (Inactive) added a comment - https://wiki.transvar.org/display/igbman/Home The page above contains a sentence that reads, "In IGB, zooming is animated, allowing you to EASILY and QUICKLY adjust the zoom level as needed." We may want to change this to, "In IGB, zooming is animated, helping you adjust the zoom level as needed."
          Hide
          mason Mason Meyer (Inactive) added a comment -

          https://wiki.transvar.org/display/igbman/View+a+bacterial+genome+in+IGB
          The page above contains a sentence that reads, "You will need to know the header of each of these files; if you are not sure, a QUICK way is to drag all of the files into IGB at the same time."

          We may want to change this to, "You will need to know the header of each of these files; if you are not sure, you can drag all of the files into IGB at the same time."

          Show
          mason Mason Meyer (Inactive) added a comment - https://wiki.transvar.org/display/igbman/View+a+bacterial+genome+in+IGB The page above contains a sentence that reads, "You will need to know the header of each of these files; if you are not sure, a QUICK way is to drag all of the files into IGB at the same time." We may want to change this to, "You will need to know the header of each of these files; if you are not sure, you can drag all of the files into IGB at the same time."
          Hide
          mason Mason Meyer (Inactive) added a comment -

          https://wiki.transvar.org/display/igbman/Creating+QuickLoad+Sites
          The page above contains a sentence that reads, "To do this, you will need to obtain sequence files and convert them to a binary format (twobit) that allow IGB to QUICKLY obtain all or part of the sequence data when users press the Get Sequence button, run a blast search, or open the Sequence Viewer window."

          We may just want to remove the word "quickly" from this sentence.

          Show
          mason Mason Meyer (Inactive) added a comment - https://wiki.transvar.org/display/igbman/Creating+QuickLoad+Sites The page above contains a sentence that reads, "To do this, you will need to obtain sequence files and convert them to a binary format (twobit) that allow IGB to QUICKLY obtain all or part of the sequence data when users press the Get Sequence button, run a blast search, or open the Sequence Viewer window." We may just want to remove the word "quickly" from this sentence.
          Hide
          mason Mason Meyer (Inactive) added a comment -

          There are no uses of the word "fun" in the user's guide...I guess that's a good thing even though IGB can be very fun to use!

          Show
          mason Mason Meyer (Inactive) added a comment - There are no uses of the word "fun" in the user's guide...I guess that's a good thing even though IGB can be very fun to use!
          ann.loraine Ann Loraine made changes -
          Summary Review the use of subjective terms in the user's guide such as "easy", "fast", "fun", etc. Expunge subjective terms from the User's Guide such as "easy", "fast", "fun", etc.
          Hide
          ann.loraine Ann Loraine added a comment -

          Exceptions:

          Introduction sections that explain the "why" of a feature.

          Show
          ann.loraine Ann Loraine added a comment - Exceptions: Introduction sections that explain the "why" of a feature.
          ann.loraine Ann Loraine made changes -
          Assignee Mason Meyer [ mason ]
          mason Mason Meyer (Inactive) made changes -
          Rank Ranked lower
          mason Mason Meyer (Inactive) made changes -
          Rank Ranked lower
          mason Mason Meyer (Inactive) made changes -
          Assignee Mason Meyer [ mason ]
          mason Mason Meyer (Inactive) made changes -
          Project IGB [ 10840 ] Deep Backlog [ 11041 ]
          Key IGBF-611 DB-197
          Workflow Loraine Lab Workflow [ 15891 ] jira [ 16979 ]

            People

            • Assignee:
              Unassigned
              Reporter:
              mason Mason Meyer (Inactive)
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated: