[SeasonOfDocs] Suggested plan for Swapnil's SeasonOfDocs/GeoNetwork work

Cameron Shorter cameron.shorter at gmail.com
Thu Dec 12 02:29:57 PST 2019


I had a chat with Swapnil today. I'm mindful that the doc task for 
GeoNetwork is huge, and that there is more than one person is going to 
be able to do in 3 months. So lets be strategic in how we make use of 
Swapnil's time.

My suggestions:

* Swapnil has had problems getting GeoNetwork installed on Windows 10. 
I've suggested installing on Ubuntu or Lubuntu, probably in VirtualBox, 
maybe also look at OSGeoLive installed into VirtualBox. (Some GeoNetwork 
folks might be able to give better advise.

* I think that Swapnil should start to build up a best practices 
recommended architecture for an Open Source docset (based on 
https://www.divio.com/blog/documentation/ )

* He should then audit existing docs against best practices to create a 
gap analysis. (For OSGeoLive work, Felicity gave a 5 start rating to all 
50 Quickstarts she worked on. Maybe do something similar).

* This should lead to a very large potential body of documentation work 
to be done, from which Swapnil should focus on specific parts.

* Focus should be on helping amplify the writing effectiveness of 
existing volunteer writers.

* This might involve providing writing templates (which are starting to 
emerge in TheGoodDocsProject)

* We should also provide a checklist about what docs should have before 
they are considered "done". The GeoNetwork Project Steering Committee 
probably should consider that a feature is not considered complete until 
it has docs which meet the minimal requirements of this checklist.

* I know Byron (and others?) have started a doc audit and built a 
spreadsheet.

* Would it be possible to get Byron, Swapnil, me (and others?) onto a 
call within the next week? Byron, what is your availability like? Maybe 
a weekday evening, or most times during this weekend should work for me. 
(Byron is in New Zealand, Swapnil and I are both in the same timezone in 
Melbourne/Sydney). Anyone else want to be included in this call?

-- 
Cameron Shorter
Technology Demystifier
Open Technologies and Geospatial Consultant

M +61 (0) 419 142 254



More information about the SeasonOfDocs mailing list