|
|
Documentation ReviewsReviewing Documentation - Quality AssuranceTechnical reports can be considered in much the same light as other products of a company. In many contract efforts, technical reports may be the only tangible products. Therefore quality assurance is as important in the preparation of reports as it is in the manufacture of hardware items or complex systems.This quality assurance and control must be exercised by knowledgeable and objective individuals with sufficient authority to initiate corrective action as appropriate. The checklists presented below are for use in accomplishing the review and quality control of various facets of a technical report. PurposeThe review process does attempt to discover any weaknesses in the project; but, its purpose is not to tear down the project or the authors. Rather, the primary purpose is to make sure that the best possible project result is obtained.FunctionHence, the primary function of the review is to provide positive feedback on how this the project/process can be improved. If you only point out the problems, you have completed only half of your responsibilities as a reviewer.Developing a Critical AttitudeThe development of a conscious critical attitude towards your own work and the work of others is an important means of self-education. You can learn more by observing how others succeed or fail in their efforts to get their ideas over than by listening to any number of lectures on the art of communicating. You need to cultivate a conscious habit of noting the source of effects in what you read. You need to be alert to new methods of communication, and become intelligent in the judgment of their value.What to ConsiderA report is a communication. If that communication fully meets all the requirements of the person to whom it is directed, and specifically all the conditions of use you may require, it should be regarded as a satisfactory communication. Involved in this communication of ideas is the writing technique itself that also may be viewed critically. You will learn much about and improve greatly your own methods of communication by consciously observing the effectiveness of the composition and noting where it is or is not effective. The following guides will show you how to observe the general techniques of others who write reports. |
|
Copyright ©1996-2001 Dale W. Kirmse, University of Florida, Gainesville, FL 32611; (352) 392-0881. This page was last updated Sunday, September 16, 2001 04:25:19 PM |
