[SeasonOfDocs] How should we focus OSGeo training within SeasonOfDocs?

[Jo Cook]

Hi All,

I really appreciate the effort Andrew has gone to in documenting the
experience of committing an update to the QGIS documentation. While this
might be slightly outside of the scope of this Google SoD I think we should
be strongly encouraging OSGeo projects to include something like this in
their documentation- and it would be great to have something like this that
we can perhaps offer as a template.

I think that the writing style was just right for new contributors- with
plenty of screenshots it was easy to follow and went through each step in
the process without missing anything. The only comment I would make is that
it would be handy to explain the very end of the process, eg what it looks
like when your contribution is accepted. Just to finish things off!

 I went to look to see if there was anything similar for Geonetwork, and I
don't think there is. @Maria and anyone else interested in improving the
Geonetwork docs, could we start on this? @Maria I notice also that the
"fork me on github" link in the Geonetwork documentation goes to a 404
error, which I would imagine might put anyone fairly new off making an edit!

In response to some of Cameron's comments (also going back to earlier in
the thread)- why are people writing training material and not making it
available in the core repository? From a commercial perspective it seems
quite simple. If we (rhetorically, and not necessarily talking about Astun
Technology here) wish to charge for training, then the training material is
surely part of what we're charging for? If we use publicly available
training material some people may complain that they are paying for
material that is freely accessible. Personally I think we should be
focusing on the manual rather than on training material as such.

Jo


On Sun, May 26, 2019 at 9:37 PM Cameron Shorter <cameron.shorter at gmail.com>
wrote:

> Thanks Matteo for the suggestions.
>
> I'm keen to lean on the experience of you and our community here to
> discuss your "How to contribute" page:
>
>
> https://docs.qgis.org/testing/en/docs/training_manual/appendix/contribute.html
>
> * Andrew Jeffry has been a newbie QGIS documented and has helped other
> newbies getting started, and has collated his experience here:
>
> https://docs.google.com/document/d/1eWpqmZHFiuoUhcCPcf9VTFrs2ol53A-Ha9in8sbiwlU/edit?usp=sharing
> . Matteo and Harrissou:How do you suggest we go forward with improving
> the getting started experience with Andrew's insights? Should we invite
> Andrew to update existing getting started page with his material?
>
> * The "How to contribute" page explains the mechanics of how to
> contribute, but where I see additional value in the SeasonOfDocs
> initiative is in addressing some of the meta issues. Answering questions
> like:
>
> ** What content do we want to accept in the QGIS manual? How do we
> decide what is in/out?
>
> ** How should each page fit within the greater documentation and
> learning vision?
>
> ** What types of documentation do we want to create?
>
> ** What is the target persona we wish to write to for each doc type?
>
> ** What writing style/tone should be applied?
>
> ** I'd be interested to hear Jared's thoughts from the perspective of a
> senior technical writer.
>
> * From the various owners of QGIS training material on this list: Why
> are you writing and using material outside of the core QGIS repository?
> What are your barriers to entry in getting back into a central location
> and collaborating on material development and maintenance)?
>
>
> On 27/5/19 3:34 am, matteo wrote:
> > Hi all,
> >
> > concerning the Training Material of QGIS I want to share some thoughts:
> >
> > It is more than welcome to add some "Use case" specific material within
> > the training manual. It still needs to be updated for QGIS 3 but have a
> > look here:
> >
> >
> https://docs.qgis.org/testing/en/docs/training_manual/forestry/index.html
> >
> > What I'll suggest is to use some specific workflow rather than
> > "duplicating" some other exercise in other section.
> >
> > Also we have a complete "How to add you contribution" chapter:
> >
> >
> https://docs.qgis.org/testing/en/docs/training_manual/appendix/contribute.html
> >
> > where all the syntax to use is described.
> >
> > We also have badges for exercises (Easy, Moderate, Hard) and a "try
> > yourself" where you can ask the user to make and exercise and then look
> > at the answer.
> >
> > Normally we suggest to provide OSM data: if data are not too complex or
> > specific it allows the user to replicate the workflow in his/her area of
> > interest by downloading the data directly in QGIS with the QuickOSM
> > plugin (another section explains how to use it
> >
> https://docs.qgis.org/testing/en/docs/training_manual/foreword/preparing_data.html
> )
> >
> > Cheers
> >
> > Matteo
> > _______________________________________________
> > SeasonOfDocs mailing list
> > SeasonOfDocs at lists.osgeo.org
> > https://lists.osgeo.org/mailman/listinfo/seasonofdocs
>
> --
> Cameron Shorter
> Technology Demystifier
> Open Technologies and Geospatial Consultant
>
> M +61 (0) 419 142 254
>
> _______________________________________________
> SeasonOfDocs mailing list
> SeasonOfDocs at lists.osgeo.org
> https://lists.osgeo.org/mailman/listinfo/seasonofdocs
>


-- 
------------------------
http://about.me/jocook
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/seasonofdocs/attachments/20190527/9e3896d2/attachment.html>