|Version 3 (modified by 3 years ago) ( diff ),|
As you may know, OSGeo Live is participating in the Google Season of Docs . I am one of your assigned Technical Writers, Felicity Brand, and I'm working on a project to review the OSGeoLive Quick Starts.
I have reviewed all 50 and scored them according to the existing Quick Start template . You can take a look at the initial status report . In 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. One version for any software that has a graphical user interface (GUI) including:
- Nav and maps
- Domain specific
Another version for any software that uses the command line interface (CLI) including:
- Web service
- Data stores
- Spatial tools
I anticipate having these ready by 3 October 2019 and at that point in time I'll be asking for help from all of you.
One 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  but there is also Microsoft and Apple. Do people have strong opinions about this?
In the meantime, we have identified a need for a glossary that encompasses OSGeo Live as a whole. Many of the projects have their own glossary and there is some value in collating these. I have started a Google sheet with the initial framework . If you can please jump in and add entries for terminology used within your project, that would be appreciated. Alternatively if you can point me at your existing glossary, I can scrape the terms out. Eventually, the glossary will be migrated from the Google sheet to a page on the OSGeo Live site. There is a trac ticket for this #2184 (https://trac.osgeo.org/osgeolive/ticket/2184).
If you would like to contribute, conversations are happening on the OSGeoLive email list or you can email me directly felicitybrand@…