[DOCU-143] Screenshots in dev environment instructions Created: 15/Apr/11  Updated: 27/May/11  Resolved: 27/May/11

Status: Closed
Project: Documentation
Component/s: content
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Antti Hietala Assignee: Suzanne Deprez
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File annotate.png     PNG File borders.png     PNG File maven-download-fuzzy.png    
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:

 Description   

The screenshots in development environment setup instructions still look awful. Tops are cut off and there is unrelated stuff at the bottom and sides. In some images it's unclear what is being illustrated and some are just not necessary for a competent person who is about to develop code.

  • Take new screenshots. Follow Documentation Style Guide
  • When shooting an OS dialog, capture the whole dialog. Don't cut off at the top. Don't leave extra stuff on the sides and bottom. See borders.png attached.
  • When it's unclear what the reader should be doing in the screenshot, use annotations and illustration. Use clean-looking arrows and circles that are hand-drawn style. Get an application that can do these. It should be part of a technical writer's toolset. See annotate.png attached. Use Magnolia corporate color scheme.
  • When shooting a part of a page, leave some white space around the element. See e.g. Field sets
  • Store at full resolution. Don't zoom out. Images get fuzzy. Bad example: starting-tomcat.png


 Comments   
Comment by Suzanne Deprez [ 18/Apr/11 ]

Dialogs were taken with Windows Snipping Tool full window snip. The cut off at the top is being done by that tool.

The window in borders.png has borders. No borders were added to images. Can start cropping windows that have borders.

With respect to maven-download-fuzzy.png, upper/left portion of screen was retained so reader could recognize they were on the correct page while executing the procedure. Since the download links also needed to be included, this resulted in an image with a width of more than 600 px. Image was reduced until width was 600 px or less.

With respect to start-tomcat.png, I wanted to leave the Command Prompt windows large enough so the reader could see enough to tell what was happening which resulted in windows wider than 600 px.

Sent E-mail with proposals for proceeding with redoing images.

Comment by Suzanne Deprez [ 22/Apr/11 ]

Activated image and page changes.

Comment by Antti Hietala [ 02/May/11 ]

Thanks. Nearly there. Please revise the following screenshots:

Comment by Suzanne Deprez [ 25/May/11 ]

The content of start-creating-settings.xml is in the previous steps. This image is meant to be an illustration of entering the steps to emphasize they must be entered within the user's home directory. The image was redone with a smaller window.

The window in select-workspace.png can't be resized.

Split set-tomcat-params.png into 2 images. Need to show where entries are in screen, hard to see at first.

Activated changes.

Comment by Antti Hietala [ 27/May/11 ]

The window in select-workspace.png can't be resized.

Then use full size.

Published other changes.

Comment by Suzanne Deprez [ 27/May/11 ]

Uploaded and activated full size for select-workspace.png.

Generated at Mon Feb 12 01:06:20 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.