Changes between Version 5 and Version 6 of How to document a project


Ignore:
Timestamp:
4 May 2019 16:33:12 (6 weeks ago)
Author:
camerons
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • How to document a project

    v5 v6  
    1111* [[How to document the overview file]]
    1212* [[How to document the quickstart file]]
     13
     14[[PageOutline(1-2)]]
     15
     16= Logo =
     17The project's logo is used in the headers of documentation (like Project Overviews, QuickStarts, Powerpoint presentations etc, and as icons on the OSGeo-Live Desktop.
     18
     19Header logo:
     20* Stored here: https://github.com/OSGeo/OSGeoLive-doc/tree/master/doc/images/projects/<project>/
     21* Filename should be "logo-<project>.png"
     22* Should have a transparent background (not white)
     23* Stored in size 125x125 pixels (for use in Project Overview and QuickStarts)
     24* For PNGs run a program like [http://packages.ubuntu.com/pngcrush pngcrush] or [http://packages.ubuntu.com/optipng optipng] to reduce the size of the image without degrading quality. For example:
     25
     26{{{
     27optipng -o5 image.png
     28}}}
     29
     30* Preferably also available as SVG, stored as "logo-<project>.svg"
     31
     32;Desktop logo:
     33: TBD: What are our requirements for desktop logos. Old docs suggested they might be:
     34:* A 32x32-pixel XPM icon for use by the Debian menus
     35:* A 48x48-pixel PNG icon for use by freedesktop.org menus
     36
     37= Screen Shot =
     38Project Overviews include an image, which is usually a screenshot, or collage of screenshots. Quickstarts include screenshots for each significant step.
     39* Images are to be stored here: https://github.com/OSGeo/OSGeoLive-doc/tree/master/doc/images/projects/<project>/
     40* The Project Overview image is to be named <project>_screenshot.png
     41* Screenshots should be taken from a 1024x768 display and should be created in PNG format.
     42* Screenshots can be taken using [http://shutter-project.org/ Shutter] (on linux) or [http://getgreenshot.org/ Greenshot] (on windows).
     43* For Quickstarts, consider marking up the image to explain the current steps. Eg: Add circled numbers: 1, 2, 3 or draw an oval around buttons being described. This is very easy to do using the "Edit" tab in the Shutter program, which provides these drawing icons to add. Tutorials augmented with detailed and pertinent images make it easy for the reader to follow what is going on. Extra time spent on an image pays off big in comprehension (you need more than just a course screen dump). Lines, numbering, highlights, boxes and annotations all help direct a user's focus to those areas which are important.
     44* Screenshots with large areas of constant color (menus, etc.) should be in PNG format, screenshots containing large areas of imagery (satellite images, shaded relief DEMs, etc.) should be in JPEG format.
     45* For PNGs run a program like [http://packages.ubuntu.com/pngcrush pngcrush] to reduce the size of the image without degrading quality.