- There are three (3) types of user documentation: reference documents, procedures manuals, and tutorials.
- Reference documents (also called the help system) are designed to be used when the user needs to learn how to perform a specific function (i.e. updating a field or adding a new record).
- Procedures manuals describe how to perform business tasks (i.e. printing a monthly report or taking a customer order)
- Tutorials teach people how to use major components of the system (i.e. an introduction to the basic operations of the system).
- Online document is the most commonly used type of documentation.
- For this assignment, you will create ONE of EACH type of documentation described above. You only need 1 page for EACH
- Save your documentation to an online location.
- Include the 3 URLS within your project.
- You will also include the 3 ACTUAL documents as an APPENDIX in your project.
- Create a section in the body of the report and write a paragraph (comprising of 5-7 sentences) that tell the reader to look in the APPENDIX for the actual document and click on the URLs for the online version.
- See Figure 12-7 for a Sample Online Documentation.
- Read what is included in Developing Documentation starting on page 456.
- Be creative. Do not extract documentation from the internet. Doing so constitutes plagiarism and will result in an “F” in the course.
- Be sure that the URLs work. Test them BEFORE you press SUBMIT. Your grade on this assignment will be based on my ability to click and read your three (3) documentation samples.
- If the documentation is in the APPENDIX, but not linked on the internet, a grade of 0 will be given.
- Build upon your Systems Analysis Project Topic from the LIST provided in the course. You will build upon this project for the entire semester. A max of 3 students may choose the SAME topic on a first-come, first-serve basis.
- Your responses must be typed directly into the Systems Analysis Project TEMPLATE under the appropriate section heading. Failure to use the TEMPLATE will result in an Automatic Grade on 0 on each assignment submitted.
- Save and upload the M/S Word project here.