Infusion Documentation Conventions
acheetham at ocadu.ca
Tue May 13 20:48:27 UTC 2014
Work on converting out documentation to markdown in Github is moving along. We have a number of pages now in the repository:
The status of the work can be tracked on the Docs Plan wiki page:
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:
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.
Anastasia Cheetham Inclusive Design Research Centre
acheetham at ocadu.ca Inclusive Design Institute
More information about the fluid-work