[SeasonOfDocs] Information Architecture

[Cameron Shorter]

Jo, I think this doc structure idea is important enough to break into a 
new email thread and get it's own title. I'm hoping to see ideas debated 
here.

I'm erring toward thinking that all our material should fit within a 
website folder. Also, I'm not sure planning deserves it's own folder. 
Instead I'm thinking it should just be thought of as a development 
branch of all the content.

If we continue to align ourselves with WriteTheDocs, as we are 
considering, we should also consider how we fit within 
https://www.writethedocs.org/

So I'm thinking our structure could be:

WriteTheDocs Website

+ <other WriteTheDocs pages>

+ *WriteTheDocsGuide / TheGoodDocsProject* -> external link to our 
guide.writethedocs.org or similar

++ Index.html (introduction and jump page)

++ Community/

+++ CodeOfConduct.html

+++ Governance.html (our decision making processes)

+++ DevelopmentProcess.html (This is likely big enough to be split out 
from Governance)

+++ CommunicatonChannels.html (how we talk with each other and how to 
get involved)

...

++ Templates/

+++ Quickstart/

+++ Template.html

+++ Guide.html (how to use the guide)

+++ Background.html (Where we discuss metadata concepts and research 
about the Quickstart)

...

++ Information Architecture

+++ <site wide information architecture theory>

+++ StarRatingSystem.html (Not sure if this deserves it's own directory)


On 11/7/19 2:28 am, Jo Cook wrote:
> Hi Felicity,
>
> Thanks for taking notes- it looks good to me. I was also thinking 
> about getting some proto-repositories going on github- with suggested 
> headings of:
>
> * governance- for holding (for now) the Code of Conduct, details of 
> PSC, licensing discussions etc
> * planning- for my nascent document on project structure
> * website
>
> That way we can use the wikis in the various repositories for some of 
> our discussion documents rather than google docs. I still like the 
> idea of google docs for the first-pass collaborative commenting on 
> quick starts though.
>
> Thoughts?
>
> Jo
>
-- 
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/20190711/1c266ce0/attachment.html>