Writing conventions
This page describes the style for writing tasks.
Here are a few recommendations while writing a task:
Same tools and words
Make sure that you achieve the task with the exact same tools as a normal author, this means using ActiveMath-SVN and jEditOQMath
Make sure you use the same wording as can be seen in these user-interfaces
Typography
- use fixed width font to denote what has to be input by the user,
in markdown, use the back-quote for this `.
- use italics to denote what the user choose from their user-interface, in markdown, surround things with underscore _.
Organization
- make sure each task declares the tasks it depends on (and links to them)
- make sure each task declares the applications it is using
- separate each step as a bullet item (use a line starting with a dash for that, -)
- make sure each slightly difficult step is followed by a check of what should happen
A test ? Make a video and see if that works well.