Details
-
Type:
Documentation
-
Status: Closed (View Workflow)
-
Priority:
Major
-
Resolution: Done
-
Affects Version/s: None
-
Fix Version/s: None
-
Labels:None
-
Story Points:1
-
Epic Link:
-
Sprint:Spring 6, Spring 7
Description
IGB 10.0.0 has been released with some new features/fixes and the User's Guide needs to be updated accordingly.
Tasks:
- Update the first image on the Selection Info page to show the newly implemented exon counting feature in the Selection Info tab
- Update the Restriction Sites page with all new pictures from the 10.0.0 release
- Add CRAM to the table of supported file formats on the File Formats page in the User's Guide
Attachments
Issue Links
- relates to
-
-
- Closed
-
Activity
Default formatting does appear to be a bit different on Windows vs Mac, but hopefully now that I've exited full screen and taken pictures in IGB with the reduced window size, these images should be more readable. I've updated the images on the Selection Info page. Could you take a look and let me know if the images and their callouts are more readable now? If so, I will update the Restriction Sites page in the same way. If not, I might need to wait until I have access to my Mac computer before updating the images any further.
There's place in the IGB Dropbox where you should save any graphic art created for the User's Guides: e.g., original images, powerpoints with call-outs, final images.
See: "IGB User's Guide" Dropbox folder.
All images and text for the User's Guide should follow the Microsoft Manual of Style book. We have several copies in the lab. Paige Kulzer - please get a copy and take one home, leave in the office.
Style example:
- Avoid complex grammar constuctions
- Use present imperative voice (ex) To do a thing, press the button labeled Do It.
- Make sure that the images are clear, i.e., you can read the text at multiple screen resolutions
- A user should not have to click on an image in order to read / understand it
Other guidelines:
If at all possible, when updating existing images, make the new image look like the old one or better (e.g. same width versus height ratio, same wording, same scene, etc.) and also use the same name for the image.
In the dropbox and with names of images, try to give informative, short names to images so that we can more easily understand what they are and what the purpose of creating was.
Selection info images look good. Go ahead and update the Restriction Sites images.
I've updated the images on the Restriction Sites page to match how I updated the Selection Info page previously.
All images used to update these two pages have been saved in Dropbox (e.g., /Users/pkulzer/Dropbox/IGB Users Guide Art and Style Info/SelectionInfo/Images/). I have also compiled the images used for each page into a powerpoint document and placed it in Dropbox along the same file path.
In the future, I will be sure to follow pre-existing naming conventions for images in the User's Guide and will continue to update Dropbox accordingly. I will also match the height/width ratio of images when I'm updating them.
For now, the Restriction Site page is ready for another review!
Images on the Restriction Site page look good.
Closing ticket.
Overview of updates made:
Selection Info:
Restriction Sites:
Note: I diverted from the task outlined for the ticket a bit here. The pictures being used currently, now that they're enlarged, do a really good job of showing mapped sites. All I would be showing with an updated image is a longer, harder to read list of restriction enzymes.
File Formats:
Note: We may want to add a section at the bottom of the File Formats page (once we've vetted CRAM usage in IGB a bit more) that explains more about what to do if the exact genome/genome version they need isn't in IGB (e.g., adding a custom genome to IGB or creating a custom quickload or emailing us to add it).