Details
-
Type:
Task
-
Status: Open (View Workflow)
-
Priority:
Major
-
Resolution: Unresolved
-
Labels:None
-
Epic Link:
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
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."
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."
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.
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! 
Exceptions:
Introduction sections that explain the "why" of a feature.
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..."