Contributing Documentation

There are two types of documentation used in the Integra project: written documentation and screencasts. All documentation should be clear, concise and focused.

• no more than 5 minutes in duration
• no more than 1000×600 pixels in size
• use the H.264 video codec at High Quality
• use Stereo audio at 96 kbits/sec

We recommend the Screenflow application for Mac.

• use Plain Text formatted using Markdown syntax
• include images to illustrate key points
• any Integra-specific terminology should be written in italics by placing a single asterisk either side of the text *like this*. Examples: arrange view, module, project
• any Integra-specific names should be written in bold by placing a double asterisk either side of the text. Examples: TapDelay1, delayTime
• Integra script should be formatted as code, by either placing a single back tick either side of the text `like this` or by indenting the code by 4 spaces per line. Examples: integra.set(“TapDelay1”, “delayTime”, .5)
• don't go any deeper than h4, i.e. ####

We recommend that you use your favourite text editor along with the Marked preview tool to write your docs.

Documentation intended for the website should be added to the project svn repository under documentation/trunk and can then be included in the Software/tutorials section on the website.

A good guide to written style can be found here.