Difference between revisions of "Assignment 5"
ChristopherS (Talk | contribs) |
ChristopherS (Talk | contribs) (added common pitfalls) |
||
Line 19: | Line 19: | ||
===Purpose=== | ===Purpose=== | ||
− | <br> | + | - The purpose of each section should be clearly stated.<br> |
+ | - State the purpose before a list of steps. ('Why' before 'How')<br> | ||
===Audience=== | ===Audience=== | ||
− | <br> | + | - Ensure language is appropriate to all readers.<br> |
+ | - Present definitions in a form that can easily be skipped by more advanced readers.<br> | ||
===Style=== | ===Style=== | ||
+ | - Use whitespace to separate sections of text.<br> | ||
+ | - Instructions should use numbers, not bullets.<br> | ||
+ | - Apply the ABC approach throughout.<br> | ||
+ | - Images should be directly referenced by the text.<br> | ||
<br> | <br> | ||
Revision as of 23:41, 9 April 2008
COMP3040 > Assignments > Assignment 5: Group Help Documentation
Introduction
Introduction here.
Contents
|
...by studentsBelow you will find real examples of what previous students have submitted, complete with comments from the marker. Learn from their successes and avoid their follies.
Avoid Common PitfallsThose who cannot learn from history are doomed to repeat it. Many students have tackled this assignment before you. Don't make the same mistakes they did. Purpose- The purpose of each section should be clearly stated. Audience- Ensure language is appropriate to all readers. Style- Use whitespace to separate sections of text. Key Applied Topics |