Changes between Initial Version and Version 1 of Press Release 88


Ignore:
Timestamp:
23 Sep 2019 20:22:10 (6 months ago)
Author:
flicstar
Comment:

Initial draft

Legend:

Unmodified
Added
Removed
Modified
  • Press Release 88

    v1 v1  
     1As you may know, OSGeo Live is participating in the Google Season of Docs [1]. We have an assigned Technical Writer, Felicity Brand, who is working on a project to review the OSGeoLive Quick Starts.
     2
     3== Quick Starts ==
     4
     5I have reviewed all 50 and scored them according to the existing Quick Start template [2]. You can take a look at the initial status report [3].
     6In order to help the community improve their Quick Start documentation, I am going to review and improve the template. It looks pretty good and I don't anticipate major changes but I would like to take the opportunity to develop two different versions of the template to cater for the difference in projects.
     7One version for any software that has a graphical user interface (GUI) including:
     8* Desktop
     9* Browser-based
     10* Nav and maps
     11* Domain specific
     12Another version for any software that uses the command line interface (CLI) including:
     13* Web service
     14* Data stores
     15* Spatial tools
     16* Libraries
     17
     18I anticipate having these ready by 3 October 2019 and at that point in time I'll be asking for help from all of you.
     19
     20== Style guide ==
     21One of the things we need is a consistent writing style and that means we should adopt a style guide. I propose the Google style guide [4] but there is also Microsoft and Apple. Do people have strong opinions about this?
     22
     23== Glossary ==
     24In the meantime, we have identified a need for a glossary so I have started a Google sheet with the initial framework [5]. If you can please jump in and add entries for terminology used within your project, that would be appreciated. Eventually, the glossary will be migrated from the Google sheet to a page on the OSGeo Live site. This will help end-users understand terms and will also allow us to link out to it and use terms confidently in our other docs knowing it is explained somewhere.
     25There is a trac ticket for this #2184 (https://trac.osgeo.org/osgeolive/ticket/2184).
     26
     27== Get involved ==
     28
     29If you would like to get involved you are very welcome. Please join the OSGeoLive mailing list or meet us on IRC at our weekly meeting.
     30
     31You can reach out to Felicity directly on the mailing lists or at felicitybrand@gmail.com
     32
     33== Links ==
     341 https://developers.google.com/season-of-docs/
     352 https://raw.githubusercontent.com/OSGeo/OSGeoLive-doc/master/doc/quickstart/udig_quickstart.rst
     363 https://docs.google.com/presentation/d/1jmSlp9GNwoPupeFJdjPsBnL7vqVG7AiWbWLEGOWEcy4/edit#slide=id.p1
     374 https://developers.google.com/style/
     385 https://docs.google.com/spreadsheets/d/19tulyAEDN5Q5n-u_jlmXIKQjPI2Lwv6fh5Orad1mz1I/edit?usp=sharing