<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body text="#000000" bgcolor="#FFFFFF">
<p>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.<br>
</p>
<div class="moz-cite-prefix">On 24/12/19 4:54 am, Swapnil Ogale
wrote:<br>
</div>
<blockquote type="cite"
cite="mid:CAD4SXx8FMcQxzSa3Bktg7PE=0w-kXTcHN=zPyXh9_NA8wb-hNw@mail.gmail.com">
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<div dir="ltr">
<div class="gmail_default"
style="font-family:verdana,sans-serif">GeoNetwork - Season of
Docs proposal<br>
<br>
Hi all,</div>
<div class="gmail_default"
style="font-family:verdana,sans-serif"><br>
Here's a short email listing the discussions Cameron, Byron
and I had on Friday, 20 Dec.<br>
(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).</div>
<div class="gmail_default"
style="font-family:verdana,sans-serif"><br>
<b>Documentation tasks (in order of priority)</b></div>
<div class="gmail_default"
style="font-family:verdana,sans-serif"><b><br>
</b>1. Work on/Update Installation Guide for Windows. </div>
<div class="gmail_default"
style="font-family:verdana,sans-serif"><i>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.</i><br>
<br>
</div>
<div class="gmail_default"
style="font-family:verdana,sans-serif">2. Perform a content
audit of existing content (Byron’s spreadsheet) and apply the
<a href="https://www.divio.com/blog/documentation/"
moz-do-not-send="true">Divio</a> (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.<br>
<i>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.</i><br>
<br>
</div>
<div class="gmail_default"
style="font-family:verdana,sans-serif">3. Set up templates
based on content types for developers.<br>
<i>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.</i><br>
<br>
<b style="">When/how I plan to tackle this (Timelines)</b><br>
End of Dec - Draft of Windows installation guide<br>
Jan 1st week - Audit of existing content to match the 4 doc
types.<br>
<br>
I'd love to hear everyone's thoughts on this.</div>
<div class="gmail_default"
style="font-family:verdana,sans-serif"><br>
Thanks,<br>
Swapnil<br>
</div>
</div>
<br>
<fieldset class="mimeAttachmentHeader"></fieldset>
<pre class="moz-quote-pre" wrap="">_______________________________________________
SeasonOfDocs mailing list
<a class="moz-txt-link-abbreviated" href="mailto:SeasonOfDocs@lists.osgeo.org">SeasonOfDocs@lists.osgeo.org</a>
<a class="moz-txt-link-freetext" href="https://lists.osgeo.org/mailman/listinfo/seasonofdocs">https://lists.osgeo.org/mailman/listinfo/seasonofdocs</a>
</pre>
</blockquote>
<pre class="moz-signature" cols="72">--
Cameron Shorter
Technology Demystifier
Open Technologies and Geospatial Consultant
M +61 (0) 419 142 254</pre>
</body>
</html>