Infusion Documentation Conventions

Mitchell, Jess jmitchell at ocadu.ca
Wed May 14 15:59:00 EDT 2014


AC,
I like the idea of you putting some style recommendations together (as you’ve done) and moving forward with standardizing the docs to meet them.

Jess


On May 13, 2014, at 4:48 PM, Cheetham, Anastasia <acheetham at ocadu.ca> wrote:

> 
> Work on converting out documentation to markdown in Github is moving along. We have a number of pages now in the repository:
> 
> https://github.com/fluid-project/infusion-docs/
> 
> The status of the work can be tracked on the Docs Plan wiki page:
> 
> http://wiki.fluidproject.org/display/fluid/Infusion+Documentation+Plan
> 
> 
> In reviewing the pages, I notice that there are minor inconsistencies across pages, for example, whether or not a word is rendered in 'code' style. In response, I've started drafting a style guide for our documents:
> 
> http://wiki.fluidproject.org/display/fluid/Infusion+Documentation+Style+Guide
> 
> The points I've put there are just a start at some recommendations – talking points. We should think this through as a group and agree on the conventions we'll use to ensure that our documentation has a consistent look and voice.
> 
> Since we haven't actually agreed on any conventions yet, I went ahead and merged the existing docs despite the inconsistencies. Once we have a style guide, we can take a pass through the docs and ensure that they all conform to whatever style we decide on.
> 
> Thoughts?
> 
> -- 
> Anastasia Cheetham     Inclusive Design Research Centre
> acheetham at ocadu.ca           Inclusive Design Institute
>                                        OCAD University
> 
> _______________________________________________________
> fluid-work mailing list - fluid-work at fluidproject.org
> To unsubscribe, change settings or access archives,
> see http://lists.idrc.ocad.ca/mailman/listinfo/fluid-work



~~~~~~~~~~~~~~~~~~~~~~
Jess Mitchell
GMT - 4:00
+1.416.977.6000 x.3965
Senior Manager, R&D + Design
OCAD University, Toronto
Inclusive Design Research Centre
jmitchell at ocadu.ca
skype: jesshmitchell
http://idrc.ocad.ca/
http://inclusivedesign.ca/
http://fluidproject.org
~~~~~~~~~~~~~~~~~~~~~~



More information about the fluid-work mailing list