Changes between Version 4 and Version 5 of How to document the quickstart file

3 Nov 2019, 14:15:30 (4 years ago)

Updated with writing tips as part of work done during Google Season of Docs 2019


  • How to document the quickstart file

    v4 v5  
    54 First sentence defines what the application does.
    55 You may also need to include a sentence of two describing the domain.
    56 Eg: For a Business Intelligence application, you should describe what
    57 Business Intelligence is.
     54.. Writing Tip: Overview section
     55This section is required and has no heading. Start with a sentence describing what the application is and does.
     57This application is a GIS Desktop client for editing and viewing Geospatial data.
     59.. Writing Tip:
     60   Next, describe what will be covered in the Quick Start. Choose a few features to show. If you're showing one or two things, write that in sentence format. If it's three or more, use a bullet list. Optionally, you can also manage expectations about the length of the Quick Start - how much time should the user expect to commit to this activity?
    5962This Quick Start describes how to:
    6164* Add a title and subtitle
    62 * Add a link
    63 * `Web Map Service (WMS) <>`__
     65* Add a link `Web Map Service (WMS) <>`__
    6466* use the standard map tools
    6567* apply color to map features using styling
     70 .. Writing tip: prerequisites section
     71     This section is optional. Mention any prerequisites that are required to complete the Quick Start, for example, internet connection or data to test with.
     73This guide uses some of the sample data included with OSGeo Live. Make sure you can access /usr/local/share/data.
    6775.. contents:: Contents
     76.. Writing Tip:
     77  Use headings in your document to automatically generate a table of contents. The headings should start with verbs, and should be the same or similar to what you have said the Quick Start will cover.
    6979This is a title
    7484Here a paragraph is starting because of the blank line above.
    7585But this line belongs to this second paragraph.
     87.. Writing Tip:
     88  The heading title for the first section is "Start application name". Use numbered steps to describe what to do. Steps start with a verb or action word. Include only one action per step. A description of the expected result is not a new step.
     89  Use Sphinx inline markup such as :guilabel: for buttons and field names; and :menuselection: for selecting menu items. Also refer to this page to describe elements on the UI
    7793This is a subtitle
    109125      .. image:: /images/projects/<slug>/image_name.png
    110126         :scale: 70 %
     127.. .. Writing Tip - Images:
     128 For images, use a scale of 50% from a 1024x768 display (preferred) or 70% from a 800x600 display. Markup the graphic with red circles to highlight any particular areas of note on the GUI (if required). Store images here:
     130.. note::
     131  Notes are optional. You can use them to provide descriptions and background information without getting in the way of instructions. Notes are rendered in the margin in some printed formats.
    113 .. note::
    114   Notes are used to provide descriptions and background information without
    115   getting in the way of instructions. Notes will likely be rendered in
    116   the margin in some printed formats.
    119 .. tip::   Tips are used to provide extra useful information, and will
    120   likely be rendered in the margin in some printed formats.
     134.. tip::   Tips are optional. You can use them to provide extra useful information or other ways of performing an action like keyboard shortcuts or drag and drop. Tips are rendered in the margin in some printed formats.
    146 This section is highly recommended, and should provide pointers further things to try.
     160This section is optional. Suggest one or several activities for people to try out on their own.
    148162Present a list of ideas for people to try out:
    168 This section is highly recommended, please provide links to further tutorials and other documentation.
     181This section is required. Provide links to any further documentation or tutorials. If your project has no further documentation, include a link to your project's website or wiki or include a contact email or mailing list to join.