|
| |
Calculation Set Checklist
Calculation sets can be considered in much the same light as other products
of a company. In many efforts, calculation sets may be the only tangible
products. Therefore quality assurance is as important in the preparation of
calculation sets 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 calculation set.
Checklist for Table of Contents
- Do the contents accurately and consistently reflect what the calculations
cover?
- Do the main divisions or heads follow some logical principle?
- Does each subsequent subdivision follow some logical principle (not
necessarily the same as for the main heads)?
- Is each main problem sufficiently subdivided to bring out all of the
significant ideas?
- Is the numbering system consistent throughout?
- Do the titles on the lists of figures and tables accurately reflect the
type and general content?
- Do the lists of figures and tables include any obvious or approximate
duplications?
Checklist for the Problem Statement
- Is a statement of the problem being considered presented?
- Are the purpose and objectives of the calculation set defined?
- Are the circumstances or conditions associated with the problem clarified?
- Are the highlights of the information presented in the detailed sections
summarized?
- Is attention focused on the key conclusions and recommendations?
- Is the plan or organization of the calculation set defined?
Checklist for the Detailed Calculations
This checklist is intended for the evaluation of presentation for a
particular problem or problem set. The checking should actually be accomplished
in six separate and distinct reviews, each focused on a particular
characteristic. These six reviews should consider the following:
- Structure and coherency.
- Completeness and conciseness.
- Accuracy of facts.
- Clarity and exactness.
- Overall integrity and appearance.
In actual practice it would be best for a reviewer to subdivide each one of
these reviews into smaller parts that focus on a single particular point. This
requires the reviewer to make more passes through the material. But since a
single point is involved, each pass can be a simple scanning operation. Such a
procedure will result in detecting more errors and omissions with minimum time
and effort. The following are brief checklists for each pass through the
calculation set:
Structure and Coherency
- Are any calculations out of logical order?
- Is each subdivision complete within itself and logically positioned within
the overall outline?
- Is the logic within each subdivision consistent?
- Does the problem statement agree with the detailed and conclusions?
- Are appropriate transitions and introductory material included where
necessary?
Completeness and Conciseness
- Are any important calculations omitted or not fully covered?
- Are any calculations omitted which, by their absence, will beg a question?
- Are any calculations unnecessarily duplicated?
- Are complete and appropriate solutions presented where problems have been
noted?
- Have all necessary facts been included without any unnecessary or
unrelated information?
- Has all irrelevant, nonessential, and trivial matter been omitted?
- Can any material be deleted or moved to an appendix without affecting the
quality of the presentation?
Accuracy of Facts
- Have all relevant physical and chemical phenomena been correctly
described?
- Has the significance of the information presented been recognized and
correctly interpreted?
- Are all statements of fact consistent with the original sources of data?
- Are all assumptions properly identified and defined?
- Are all arithmetic and mathematical presentations complete, consistent,
and accurate?
- Are all references complete and accurate?
- Are all dates, physical data, performance data, names of people and
places, and other similar items consistent with the original sources?
- Are individual facts consistently presented from one calculation set to
another?
- Do all totals accurately reflect the sum of the associated parts?
Clarity and Exactness
- Does the narrative say exactly what it is supposed to say in the final
version?
- Do the illustrations depict exactly what they are supposed to depict.
- Do all of the words and phrases accurately reflect the ideas being
presented?
- Are numbers and numerals used appropriately and consistently?
- Are abbreviations used in the calculations? If so, would the presentation
be clearer if the words were spelled out?
- Have all symbols been identified in a glossary with corresponding words or
abbreviations?
- Where used, are abbreviations either in accordance with standard
definitions or properly defined?
- Are the headings appropriate and consistent throughout?
- Is the item-numbering system appropriate and consistent throughout?
- Are all illustrations and formal tables referenced in the appropriate
locations?
- Do the figure and table references accurately correspond to the material
being referenced?
Final Overall Review
- Does the calculation set present a complete and logical development of the
solution?
- Is the calculation set clear and easy to read?
- Does the calculation set reflect an appropriate balance between narrative
and illustrations?
- Does the theme come through forcefully?
- Does the narrative reflect proper balance between important and secondary
problems?
- Does the calculation set reflect the basic "problem identification,
plan of attack, basis, details, summary' theme at the overall level and at
appropriate major subdivisions?
- Are the calculations easy to follow?
- Has sufficient prose been included to read the calculations?
- Have conclusions of the calculations been given?
- Are headings given and are the calculations indexed?
- Are the calculations accurate and have error limits been noted?
Checklist for the Conclusions Sections
- Are logical conclusions presented that easily relate the information
contained in the detailed sections?
- Is the achievement of the objectives or goals established in the problem
statement recognized?
- Are intelligent and practical recommendations commensurate with the
conclusions developed?
- Are appropriate summary statements included so as to make the closing
relatively independent of the detailed sections?
- Are statements with regard to future action presented where appropriate?
Checklist for Tables
Checklists for Illustrations
Adapted from: Woelfle, R.M. "Technical Reports". In S.
Jordan, J.M. Kleiman, and H.L. Shemberg, eds. Handbook of Technical Writing
Practices. Wiley-Interscience, N.Y. (1971).
|