The purpose of this document is to clarify what I expect from you in your class project reports. Your report should in general follow the "design process" as described in Chapter 1 of the text Design of Machinery in terms of content, order, and format. In a particular project it may not be germane to include all parts of the design process. For example, if the project involves only analysis but no synthesis, then the ideation step may be omitted. If the problem is principally a synthesis one, then the analysis step might be de-emphasized, but probably not eliminated, since some analysis of proposed designs is always needed.

    The principal purpose of the project report is to communicate to me and anyone "skilled in the art" what, why, and how you did what you did. Many students ask "What do you want written in the 'design description' part of the report?" Your design description should tell me what your design is, and most importantly, how you arrived at it. The process used to go from problem statement to design solution is not an obvious one. It is not possible for me to look at your solution and judge your depth of understanding of the problem unless you tell me about the steps you took to arrive at the solution.

    An analogy to a more conventional test situation might be a mathematics test in which you copied the problem statement and then set down the correct solution but did not show any of the many mathematical steps necessary to get to the solution. I think that neither you nor I would be surprised to see a lowered grade on that problem, despite the correct answer, because you failed to "show the work."

    Thus, I want you, in your design description, to "show and tell" me what you did, and how you did it, such that I can follow your thinking during the design process and solution.

    Another important part of the report will be the background research portion. Depending on how unstructured the problem statement is, this may be a large or small part of the report. A tightly constrained project in which you have been given a set of task specifications will typically have little in the way of background research to report. A loosely constrained project where you have merely been given a problem statement will require a large amount of background research into the problem in order to structure it and create appropriate task specifications.

    If the project largely involves the development of a computer solution or computer program, then the "design description" should discuss the assumptions made, the limitations of the algorithm used, the data structure used and the design of the program. Again the purpose is to help me understand how you arrived at your particular solution.

    The report format is rigidly constrained and must exactly follow these specifications, so be sure to read them. Reports not meeting those specifications will be downgraded.

2. Order of Contents in the Report

    The contents must be as follows, in the order listed.

A. Title Page: There must be a title page, as the first page, containing the title of project and its sequence number in the course, your name, and date submitted. The title block information may not exceed 4" wide by 2" high centered in the upper third of the title page. The rest of that page must be blank for purpose of comments and grade.

B. Abstract: (See below for description)

C. Table of Contents: An example follows with page #'s to indicate suggested lengths.

1. Introduction 1

2. Background Research 2

3. Goal Statement 10

4. Task Specifications 10

5. Design Description 12

6. Results 20

7. Conclusions 24

8. Bibliography 26

9. Appendices 27

10. Model inside back cover

11. Computer Disk inside front cover

(each of these will now be discussed in turn)

D. Introduction: This serves to define the original problem statement as given and sets the scene for what follows.

E. Background Research: This section should be a thorough and extensive discussion of all you have learned about the general background of the problem. This includes, but is not limited to, discussion of existing designs and their limitations, results of surveys, limited calculations to investigate feasibility, patent searches, literature searches, references etc. In short, you will report what you have learned about the relevant topics of concern.

F. Goal Statement: This is a clear, concise restatement of the problem in the light of things learned during the background research phase. Use Functional Visualization. (See the Design Process in Chapter 1)

G. Task Specifications: This is a clearly stated list of performance specifications, which, in your judgment, are both necessary and possible in order to achieve the stated goal. You must add your own new specifications to any that are given! (See Design Process)

H. Design Description: This will be an extensive section of the report which describes your progress and activities in arriving at and rejecting possible solutions. It will, in short, be a record of your iteration through steps 5, 6 and 7 of the Design Process, (cf.). This section should be liberally illustrated with figures and tables to graphically document your designs and analyses. Short mathematical exercises may be included within this section, but lengthy derivations or exercises should be placed in the appendix. See also the first section of this document, (General Information), and also the Design Process for additional insight into what is expected in this section. Note that all figures, sketches and tables included in the report must be labeled with a title and "Figure #" or "Table #", and must be placed near where they are described, discussed and explained in the text. Illustrations and computer printouts are not to be used as filler or window dressing! They are only to be included if they convey information and are discussed in the text. Unreferenced illustrations will be ignored!

I. Results: This section clearly describes your final results, design or other accomplishments. It should also contain illustrations documented and discussed as described in Section H. This section deals with step (8) in the Design Process (cf.).

J. Conclusions: This section is important from an academic standpoint, though it probably would not appear in a professional report in industry. Here you describe what you learned in this project, what pitfalls you encountered and what gains or insights you made. This is a valuable aid to us in planning future projects to improve the educational experience. Tell us if this exercise was of value to you or not, and how it could be improved. This is required!

K. Bibliography: contains all references used in report listed by author, title and publisher.

L. Appendices: An appendix means an "add-on". This is the repository for all data or information which are useful but would otherwise interrupt the flow of the report if included in its body. Examples of items belonging in the appendix are: computer programs or extensive printouts, catalog information, mathematical proofs or derivations, extensive test data, etc. Do not put individual illustrations which are germane to the design discussion in the appendix! They should be in the body of the report and be discussed there. Reference must also be made in the report to all material which is in the appendices. If it is not referenced or discussed, it should not be there! It is then just filler!

M. Model: If required - must be the last item in the report, and must be either bound into the report on a sturdy 8-1/2" x 11" cardboard base or mechanically attached to the inside back cover. It must be possible to move the model through its range without removing its base from the report. The model and its background plane should be illustrated to indicate its orientation and interaction with the environment.

N. Floppy Disk: If required, must be securely protected in a disk jacket (sleeve) which you have attached to the inside front cover.

O. Abstract: Though this appears first in the report, it must actually be written last, because an abstract is intended to summarize the results of the exercise. It must clearly and concisely (in 1/2 to 1 page maximum) describe what you set out to do and what you did. It is not just a restatement of the problem. It is a summary of your results and accomplishments. Thus it cannot be written until the report is finished.