Difference between revisions of "Assignment 5"
ChristopherS (Talk | contribs) (added common pitfalls) |
ChristopherS (Talk | contribs) (added introduction) |
||
Line 11: | Line 11: | ||
|Introduction = | |Introduction = | ||
− | + | This assignment deals with every Computer Science student's favorite subject; help documentation. Love it or hate it, help documentation is an important part of any development project. Regardless of how powerful or well coded your software is, the end user will require help documentation to take full advantage of it. This assignment will hone your help documentation writing skills so you can avoid late night support calls in the future. | |
+ | |||
+ | There are 4 major factors that contribute to a good help document: | ||
+ | # [[Purpose| Determining what questions the users will need answered.]]<br> | ||
+ | # [[Audience| Determining who will be reading the help documentation.]]<br> | ||
+ | # [[Graphics| Ensuring the document can be easily related to the actual software.]]<br> | ||
+ | # [[Page_Layout| Ensuring the document can be easily read, or used as a reference.]]<br> | ||
}} | }} | ||
Revision as of 23:55, 9 April 2008
COMP3040 > Assignments > Assignment 5: Group Help Documentation
Introduction
This assignment deals with every Computer Science student's favorite subject; help documentation. Love it or hate it, help documentation is an important part of any development project. Regardless of how powerful or well coded your software is, the end user will require help documentation to take full advantage of it. This assignment will hone your help documentation writing skills so you can avoid late night support calls in the future.
There are 4 major factors that contribute to a good help document:
- Determining what questions the users will need answered.
- Determining who will be reading the help documentation.
- Ensuring the document can be easily related to the actual software.
- Ensuring the document can be easily read, or used as a reference.
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 |