Identify one of the common mistakes made by novice analysts in preparing user documentation? Explain why the mistake may happen and the possible consequences.
User documentation are user manuals, training manuals, and online help systems that are designed to help the user operate the system. It either explains how it operates or how to use it, and may mean different things to people in different roles. A mistake novice analysts can make when preparing user documentation is not reading the user manuals before operating the system. This mistake may happen due to miscommunication from management and could cause mistakes within the company, and its operations.
One possible mistake in preparing user documentation is that they take a cautious way of leaving user documentation until the end of the project because it takes a prolonged amount of time in doing so. Therefore some items of the user documentation can and may be left and should be prepared during and throughout the project
Novice programmers tend to get caught up in the actual development of the programs and tend to ignore testing and documenting their work. Since development of the programs is usually more fun than testing, it receives more attention.
Novice analysts often make mistakes when using online documentation. Online documentation is taking precedence to the old paper-based manuals, even though paper- based documentation is simpler to use. Novice analysts make mistakes with the online documentation because they typically have less computer experience.
Another mistake that novice analysts may make when preparing user documentation is not understanding the user. Successfully preparation of this document requires that the analysts have an understanding of the range of users as well as a knowledge of what skills the users have. Failure to do so can result in unhappy users because they don't have the skills or knowledge to use the program based off what the analyst provided them with.
Another possible downside or strategy that can lead to mistakes is using paper documentation. Paper documentation is more comfortable for most to use and is portable however online documentation is becoming more predominant because it allows the team to view/edit documentation from any location easily. Thus you may lose time through using paper documentation, even though online poses unfamiliar to most it is fast growing.
One of the major mistakes I've made and seen in creating user documentation is being too technical. Sometimes we forget that other people might not have the same level of understanding or interest in the technical side of a system. User documentation should be as simple and straight forward as possible. The reader/user should be presented with all the necessary information, but it should be presented in a way anyone can understand.
User documentation are user manuals, training manuals, and online help systems that are designed to help the user operate the system. It either explains how it operates or how to use it, and may mean different things to people in different roles. A mistake novice analysts can make when preparing user documentation is not reading the user manuals before operating the system. This mistake may happen due to miscommunication from management and could cause mistakes within the company, and its operations.
ReplyDeleteOne possible mistake in preparing user documentation is that they take a cautious way of leaving user documentation until the end of the project because it takes a prolonged amount of time in doing so. Therefore some items of the user documentation can and may be left and should be prepared during and throughout the project
ReplyDeleteNovice programmers tend to get caught up in the actual development of the programs and tend to ignore testing and documenting their work. Since development of the programs is usually more fun than testing, it receives more attention.
ReplyDeleteNovice analysts often make mistakes when using online documentation. Online documentation is taking precedence to the old paper-based manuals, even though paper- based documentation is simpler to use. Novice analysts make mistakes with the online documentation because they typically have less computer experience.
ReplyDeleteAnother mistake that novice analysts may make when preparing user documentation is not understanding the user. Successfully preparation of this document requires that the analysts have an understanding of the range of users as well as a knowledge of what skills the users have. Failure to do so can result in unhappy users because they don't have the skills or knowledge to use the program based off what the analyst provided them with.
ReplyDeleteAnother possible downside or strategy that can lead to mistakes is using paper documentation. Paper documentation is more comfortable for most to use and is portable however online documentation is becoming more predominant because it allows the team to view/edit documentation from any location easily. Thus you may lose time through using paper documentation, even though online poses unfamiliar to most it is fast growing.
ReplyDeleteOne of the major mistakes I've made and seen in creating user documentation is being too technical. Sometimes we forget that other people might not have the same level of understanding or interest in the technical side of a system. User documentation should be as simple and straight forward as possible. The reader/user should be presented with all the necessary information, but it should be presented in a way anyone can understand.
ReplyDelete