User Documentation

Catalog description

This course gives the student practical experience in developing and preparing user documentation for software and hardware products. Discussions emphasize the importance of knowing your audience and writing efficient documentation that is clear, concise, and accurate. Students learn and experience first-hand the end-to-end documentation process. Instruction will be provided in the use of industry leading help authoring tools (such as Adobe Acrobat Pro DC and MadCap Flare). Students will design and develop an online help project complete with embedded help, navigational aids, table of contents, index, and glossary. The major requirement for this course is researching and developing a form of user documentation, such as a user guide, reference guide, or tutorial. The user documentation completed as a PDF and in HTML output will be of a quality that it can be used as part of the student’s portfolio.