Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCU-143

Screenshots in dev environment instructions

    XMLWordPrintable

Details

    • Task
    • Resolution: Fixed
    • Neutral
    • None
    • None
    • content
    • None

    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

      Checklists

        Acceptance criteria

        Attachments

          1. annotate.png
            annotate.png
            74 kB
          2. borders.png
            borders.png
            98 kB
          3. maven-download-fuzzy.png
            maven-download-fuzzy.png
            195 kB

          Activity

            People

              sdeprez Suzanne Deprez
              ahietala Antti Hietala
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Checklists

                  Task DoR