One type of documentation is Tutorials. This is to teach people how to use the system, and its major components. The book explains, "e.g., an introduction to the basic operations for the system." (pg. 458) These are usually done in sequence, so they build upon another before learning the next step. The primary goal is to help the people learn to use the system.
One type of documentation is reference documents, which is also known as the help system. Reference documents are designed to teach a user how to complete a specific function. An example of a specific function would be the user adding a new record or updating an existing list. Usually Reference documents are only used after a user has attempted and failed to perform a specific function. Therefore, reference documents must be clear and easy to understand because the user is often frustrated and impatient when they use them.
The last type of documentation is the of procedural manuals. Procedural manuals are documentation tools to of how to perform certain business tasks and guides users thru a certain task that requires many functions and steps. These are often longer than references and are meant to be read individually.
There are many examples of each type of documentation. An example of a reference document is simply put in place for the assistance of users that have attempted some function but failed to perform it. User "refer" to this document for guidance in completing the function. An example of a procedure manual is simply put in place to describe the specific function ever before it is attempted or failed. An example of a tutorial could be a "help" button in a particular system. That feature allows a function to be performed in sequence to complete a function.
The primary goal of tutorial documentation is to teach people how to use major components of the system. For example, a tutorial could be to take a user step by step when first trying to use Excel spreadsheets. Usually each entry in the tutorial is longer still than entries in procedure manuals, and the entries are typically designed to be read in sequence. Where as entries in reference documents and procedure manuals are meant to be read individually.
One type of user documentation is known as Reference documents. These documents, also known as the help system are designed to help the user learn how to perform a specific function.
One type of documentation is procedural manuals. These describe how to perform specific business tasks. It will guide the user through the different steps required to perform that task. Since there are so many steps, the entry will usually be longer than an entry in a reference guide.
One type of documentation is Tutorials. This is to teach people how to use the system, and its major components. The book explains, "e.g., an introduction to the basic operations for the system." (pg. 458) These are usually done in sequence, so they build upon another before learning the next step. The primary goal is to help the people learn to use the system.
ReplyDeleteOne type of documentation is reference documents, which is also known as the help system. Reference documents are designed to teach a user how to complete a specific function. An example of a specific function would be the user adding a new record or updating an existing list. Usually Reference documents are only used after a user has attempted and failed to perform a specific function. Therefore, reference documents must be clear and easy to understand because the user is often frustrated and impatient when they use them.
ReplyDeleteThe last type of documentation is the of procedural manuals. Procedural manuals are documentation tools to of how to perform certain business tasks and guides users thru a certain task that requires many functions and steps. These are often longer than references and are meant to be read individually.
ReplyDeleteThere are many examples of each type of documentation. An example of a reference document is simply put in place for the assistance of users that have attempted some function but failed to perform it. User "refer" to this document for guidance in completing the function. An example of a procedure manual is simply put in place to describe the specific function ever before it is attempted or failed. An example of a tutorial could be a "help" button in a particular system. That feature allows a function to be performed in sequence to complete a function.
ReplyDeleteThe primary goal of tutorial documentation is to teach people how to use major components of the system. For example, a tutorial could be to take a user step by step when first trying to use Excel spreadsheets. Usually each entry in the tutorial is longer still than entries in procedure manuals, and the entries are typically designed to be read in sequence. Where as entries in reference documents and procedure manuals are meant to be read individually.
ReplyDeleteOne type of user documentation is known as Reference documents. These documents, also known as the help system are designed to help the user learn how to perform a specific function.
ReplyDeleteAn example of a reference document would assist users in adding a new customers information such as address, telephone number, etc.
ReplyDeleteAn example of a precedural manual would help users perform certain business tasks, such as printing a monthly report or taking a customer's order.
An example of a tutorial would be an introduction to the basic operations of a system.
One type of documentation is procedural manuals. These describe how to perform specific business tasks. It will guide the user through the different steps required to perform that task. Since there are so many steps, the entry will usually be longer than an entry in a reference guide.
ReplyDelete