Screenshots in dev environment instructions
-------------------------------------------
Key: DOCU-143
URL: http://jira.magnolia-cms.com/browse/DOCU-143
Project: Documentation
Issue Type: Task
Security Level: Public
Components: content
Reporter: Antti Hietala
Assignee: Antti Hietala
Attachments: annotate.png, borders.png, maven-download-fuzzy.png
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|http://wiki.magnolia-cms.com/display/DOCU/Documentation+Style+Guide#DocumentationStyleGuide-Imagesandscreenshots]
* 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|http://documentation.magnolia-cms.com/modules/form.html#Fieldsets]
* Store at full resolution. Don't zoom out. Images get fuzzy. Bad example:
[starting-tomcat.png|http://documentation.magnolia-cms.com/dms/developing/dev-environment/tomcat/starting-tomcat.PNG]
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://jira.magnolia-cms.com/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
----------------------------------------------------------------
For list details see
http://www.magnolia-cms.com/home/community/mailing-lists.html
To unsubscribe, E-mail to: <[email protected]>
----------------------------------------------------------------
