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 3 in the user's guide it says to use consistent terminology to promote learning of technical concepts and a better understanding of them.
Examples of inconsistent terminology in the IGB user's guide includes "Start IGB", "Launch IGB" , "Run IGB", and "Open IGB".
This story will hold comments below containing the places in the IGB user's guide where one of the terms above are listed.
At some point soon we will have to decide on one term and update all places identified in the comments below.
Attachments
Activity
| Field | Original Value | New Value |
|---|---|---|
| Epic Link | IGBF-140 [ 14594 ] |
| Rank | Ranked higher |
| Summary | Choose consistent user guide term for "Start IGB" | Choose consistent user's guide term for "Start IGB" |
The phrase "Launch IGB" (or something similar) can be found on the following pages:
https://wiki.transvar.org/pages/viewpage.action?pageId=34800222
https://wiki.transvar.org/display/igbman/Java+Web+Start+starts,+but+fails+to+launch+IGB
https://wiki.transvar.org/display/igbman/Getting+Older+Versions+of+IGB
https://wiki.transvar.org/display/igbman/Scripting+and+the+IGB+command+language
https://wiki.transvar.org/display/igbman/Tabbed+panels
https://wiki.transvar.org/display/igbman/Unable+to+launch+the+application
https://wiki.transvar.org/display/igbman/Quick+start
https://wiki.transvar.org/display/igbman/Assessing+splicing+-+Cold-induced+alternative+splicing+of+Arabidopsis+SR45
https://wiki.transvar.org/display/igbman/RNA-Seq+Coverage+graphs+-+Visualizing+data+from+maize+reproductive+transcriptomes
The phrase "Run IGB" (or something similar) can be found on the following pages:
https://wiki.transvar.org/display/igbman/Getting+Older+Versions+of+IGB
https://wiki.transvar.org/pages/viewpage.action?pageId=18252014
https://wiki.transvar.org/display/igbman/Unable+to+launch+the+application
https://wiki.transvar.org/display/igbman/Get+IGB
https://wiki.transvar.org/display/igbman/Command+Line+Arguments
The phrase "Open IGB" (or something similar) can be found on the following pages:
https://wiki.transvar.org/display/igbman/Set+up+a+Quickload+in+Dropbox
https://wiki.transvar.org/pages/viewpage.action?pageId=34800222
https://wiki.transvar.org/display/igbman/Personal+Synonyms
https://wiki.transvar.org/display/igbman/View+a+bacterial+genome+in+IGB
https://wiki.transvar.org/display/igbman/Creating+QuickLoad+Sites
| 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 3 in the user's guide it says that use consistent terminology to promote learning of technical concepts and a better understanding of them. Examples of inconsistent terminology in the IGB user's guide includes "Start IGB", "Launch IGB" and "Open IGB". This story will hold comments below containing the places in the IGB user's guide where one of the terms above are listed. At some point soon we will have to decide on one term and update all places identified in the comments below. |
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 3 in the user's guide it says that use consistent terminology to promote learning of technical concepts and a better understanding of them. Examples of inconsistent terminology in the IGB user's guide includes "Start IGB", "Launch IGB" , "Run IGB", and "Open IGB". This story will hold comments below containing the places in the IGB user's guide where one of the terms above are listed. At some point soon we will have to decide on one term and update all places identified in the comments below. |
| 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 3 in the user's guide it says that use consistent terminology to promote learning of technical concepts and a better understanding of them. Examples of inconsistent terminology in the IGB user's guide includes "Start IGB", "Launch IGB" , "Run IGB", and "Open IGB". This story will hold comments below containing the places in the IGB user's guide where one of the terms above are listed. At some point soon we will have to decide on one term and update all places identified in the comments below. |
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 3 in the user's guide it says to use consistent terminology to promote learning of technical concepts and a better understanding of them. Examples of inconsistent terminology in the IGB user's guide includes "Start IGB", "Launch IGB" , "Run IGB", and "Open IGB". This story will hold comments below containing the places in the IGB user's guide where one of the terms above are listed. At some point soon we will have to decide on one term and update all places identified in the comments below. |
I think "start IGB" is the most clear if we're instructing users to go from the state of IGB not running to the state of IGB running.
Use "Start IGB"
Older terminology was more consistent with using Java Web Start.
| Rank | Ranked lower |
| Rank | Ranked lower |
The phrase "Start IGB" can be found on the following pages:
https://wiki.transvar.org/display/igbman/Quick+start
https://wiki.transvar.org/display/igbman/New+in+IGB+6.7
https://wiki.transvar.org/display/igbman/Assessing+splicing+-+Cold-induced+alternative+splicing+of+Arabidopsis+SR45
https://wiki.transvar.org/display/igbman/RNA-Seq+Coverage+graphs+-+Visualizing+data+from+maize+reproductive+transcriptomes