[SeasonOfDocs] GeoNetwork - Season of Docs proposal

[Cameron Shorter]

Thanks Swapnil, this aligns with what we discussed, and should keep you 
occupied for a few weeks. I'll be interested to hear from Jo and Paul 
after the Xmas period, who I suspect will be able to tweak the direction 
later.

On 24/12/19 4:54 am, Swapnil Ogale wrote:
> GeoNetwork - Season of Docs proposal
>
> Hi all,
>
> Here's a short email listing the discussions Cameron, Byron and I had 
> on Friday, 20 Dec.
> (Unfortunately, Jo and Paul couldn't make it, so we have probably 
> missed insights from the recent doc sprint, but we came up with the 
> following suggestions to get me going over the next few weeks).
>
> *Documentation tasks (in order of priority)*
> *
> *1. Work on/Update Installation Guide for Windows.
> /I had some trouble installing GeoNetwork on a Windows machine using 
> the current docs and I thought there was an opportunity to improve 
> these docs for potential users as a quick win./
>
> 2. Perform a content audit of existing content (Byron’s spreadsheet) 
> and apply the Divio <https://www.divio.com/blog/documentation/> (4 doc 
> types) against the content to identify doc types. Bryon's spreadsheet 
> gives us a good understanding of where we are in terms of current 
> documentation for the GeoNetwork project and gaps.
> /The aim here is to see if we can logically split docs into Tutorials, 
> Howtos, Explanations, and References, which would make them easier to 
> maintain./
>
> 3. Set up templates based on content types for developers.
> /The aim here is to make it easier for developers, users, tech writers 
> and me to write good docs. There are some best practices getting 
> developed in TheGoodDocsProject which I'm hoping to build upon./
>
> *When/how I plan to tackle this (Timelines)*
> End of Dec - Draft of Windows installation guide
> Jan 1st week - Audit of existing content to match the 4 doc types.
>
> I'd love to hear everyone's thoughts on this.
>
> Thanks,
> Swapnil
>
> _______________________________________________
> 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

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/seasonofdocs/attachments/20191224/08f6a32a/attachment.html>