Assignment 5

COMP3040 > Assignments > Assignment 5: Group Help Documentation

Introduction

Introduction here.

...by students Below 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. Example Help Documentation The first example is an excellent of how help documentation and instructions should be written. Avoid Common Pitfalls Those 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. - State the purpose before a list of steps. ('Why' before 'How') Audience - Ensure language is appropriate to all readers. - Present definitions in a form that can easily be skipped by more advanced readers. Style - Use whitespace to separate sections of text. - Instructions should use numbers, not bullets. - Apply the ABC approach throughout. - Images should be directly referenced by the text. Key Applied Topics ABC Approach Audience Instructions Page Layout Graphics Instructional Documentation Using Google Docs