|
Subject name: Software Project Documentation |
|
Author : Topic content : |
Course Introduction, Understanding task orientation .Writing to teach- Tutorials, Writing to Guide - Procedures,Writing to Support - References, Analyzing Your user, Planning and Writing your documentation, Getting Useful reviews,Conducting usability tests. Editing and Fine Tuning, Designing for task orientation, Laying out pages and screens, Getting the language right, Using graphic effectively, Designing Indexes, Project presentation Upon completion of this course, the students will be able to:
• Should know the primary system, project, and task orientation terms.
• Should be able to understand the type of users and their psychological differences. • Should be able to construct a task list for a project.
• Should be able to learn the type of documents we produce and the kind of users they use such documents.
• Should be able to differentiate between the different types of each document and the kind of elements that compose the document.
• Should be able to understand the user analysis, planning interviews, and learn the rules when interviewing users.
• Understand how to start the project and set up a plan for that
• Understand the importance of reviews, testing, and editing. The rules for each and how you schedule them and with whom.
• Understand and create a table of contents and match the user analysis with the document design
• Create a thumbnail sketch as the first step of laying out pages and screens.
• Understand the importance of “getting the language right” on the document usability and acceptance by the user.
• Introduce graphics to the document and understand the effectiveness of graphics on the document. • Understand the build indexes for the document.