Senior Design Report Content and Formatting
When preparing the final written report, adhere to the following format:
- Paper: Use only one side.
- Margins: Left: 1.25", Right: 1.25", Top: 1", Bottom: 1"
- Regular text: 12pt Times Roman with 1-1/2 line spacing.
- Source code: 10pt Courier Monospace with single spaced lines.
The final report must be organized as described below. With prior approval of your advisor, you may use a variation of this format as long as it provides an equally clear way of organizing your information, and provided that such variations are restricted to the introduction and main body sections of your report.
Successful completion of your senior design project requires that a PDF version of the final report be submitted to your advisor and posted on the department website. One printed copy of your final report must be submitted to the department for filing in the University library. The library requires that all senior project reports be bound in black velobinding with clear, hard plastic covers.
This form has a set format. You are required to use the format shown in this MS/Word document.
This form also has a set format. You are required to use the format shown in this MS/Word document.
A good abstract is a concise summary (1–2 paragraphs) of the entire project: introduction, problem statement, work accomplished, results, conclusions, and recommendations. When you write the abstract, imagine that the reader will not read anything else, but that you must get your major point across immediately. This requires efficiency of words and phrases. An abstract is written to stand alone, without jargon or reference to figures and tables in the report body.
Acknowledge the contributions of the sponsor, university staff, other students, faculty, and other persons who were of assistance. This section is optional.
Table of Contents
Each report must have a table of contents which shows the principal divisions of the report. These divisions must agree, in wording and style, with the divisions shown in the text.
List of Figures and List of Tables
The table of contents should be followed by a page containing a list of figures, and another containing a list of tables (if any).
Each figure that appears in your report should have a figure number and title, centered below the figure. Figures appearing within the body of your report should be consecutively numbered, and should appear as soon as is convenient after the figure is first mentioned. Do not insert large gaps or blanks in the text.
Each table should have a table number and title centered above the table. Short tables should be placed within the text as near as possible to where they are needed, and not put on a separate page. If possible, two short tables can be put on the same page. Large tables may need to go on a separate page. Tables should appear as soon as is convenient after the table is first mentioned in the text.
Figures or tables that require pages to be bound sideways (landscape format) should be oriented so that their bottom is along the right-hand margin.
Introduction (First Chapter)
The introduction should be approximately 1–3 pages in length, and should contain the following information:
- Problem statement: Make a concise statement of the problem, ideally in a few sentences, but no more than a paragraph. For example, try to complete this statement: “The sponsor desires that ... (insert goals of the project) ... subject to the following criteria: ... (insert numbered list).” These goals and criteria help to define the scope of work and the deliverables.
- Background or Related Work: State who else has worked on this problem or similar problems (you should do most of your citations here). For applied projects, provide information on other existing programs which will use your program.
- Objectives: The objectives are a battle plan for the project. They are a breakdown of steps or accomplishments that must be completed to achieve the project goals.
Main Body (Middle Chapters)
This portion of your report may correspond to several separate sections or chapters that describe the work completed to achieve the objectives listed in the introduction. Typically, each objective will become a longer and more elaborate section in the body. Include additional background needed and not given in the introduction, describe the approach used, present the results, and assess the significance of each result in achieving the objectives of the project. Avoid using code and implementation details here; instead, define the solution in terms of algorithms, pseudocode, and clear mathematical reasoning. Include relevant data analyzed, discussion of results of calculations and experiments, drawings of prototypes; place figures, screen shots, and tables where they enhance discussion in the text. Graphs and statistics are always useful to summarize large amounts of data, and are desirable in technical documents. When your report includes equations, they should be numbered near the right-hand margin.
If you do not think an issue, such as ethics for example, has any relation to your project, you can say so, but you should justify this. These responses need not be lengthy, but you should say something about each of the following issues:
Ethical conduct is what one ought to do in working with others. It is the right thing to do, the moral action. It is not surprising that virtually all of our professional societies and groups, in all professions, have codes of ethical conduct. Professions realize that there are good and bad ways of working with others, and we need to make the distinction. Sometimes it can be difficult to know what is the right thing to do. What ethical questions were or could be raised about your project?
Engineering is done within a social context, within a community of other people. Sometimes that community is defined very narrowly, sometimes very broadly. A focus on social issues allows us to consider the impact of our work on society. If we develop this product, or implement this system, what will be the effect? All of our human developments, in engineering and elsewhere, have unanticipated consequences, some good, some bad. We have an obligation to reflect on these consequences as well as we are able.
Many of our projects are very political in nature, requiring us to take into consideration the will of the general public, usually through elected representatives. Engineers who work on public projects need to understand the political processes that make such work possible. What is the potential impact of your project or this type of project on society?
Economic considerations in engineering concern the costs of the various steps in the project. Such costs are usually dependent on the engineering decisions that are made during the design phase. Alternative approaches may offer cost options. We also need to consider the cost of money. How do we pay for the cost of a product development? If we must borrow significant amounts of money how do we account for the cost of the loan in the pricing of the product? What economic considerations arose in your project?
Health and Safety
We develop our products for the use of the public. Hence we must consider health and safety issues related to our product. How safe does a product have to be? Are there laws that determine this? Are there related ethical issues? What health effects are relevant? What health and safety issues arose in your project?
Manufacturability issues are of great importance. Can the product be built? Is there an easier way to build this product than first imagined? What development time issues arise? What are the cost issues? Could your project be manufactured? What problems might arise?
Sustainability means two things in engineering; one is a narrow sense, one broad sense. In the former sense sustainability refers to the degree to which a product that is developed can continue to be viable and useful for a reasonable amount of time. A product that fails soon after it is built and cannot be repaired or updated or modified to fit new needs is not a sustainable product. In the broader sense a community or region or a world, perhaps, that uses its resources effectively so that it can sustain its life for a long time is said to be sustainable. We say that such a community has a sustainable economy. Engineering can help develop sustainable economies. What sustainability issues arise?
All of our products and systems have some environmental impact, in the uses of valuable resources, or in the production of pollution, or in other changes in our surroundings. The engineer is obliged to consider such impacts, and to point them out where they arise, or are a threat. What are the environmental issues related to your product?
Usability refers to what is sometimes called “user-friendliness.” Is the device straightforward, easily learned and easily used by the end user. Is your product usable?
Lifelong learning is a necessary part of all professions. You wouldn’t want to have a doctor who did not know the latest procedures and medications to protect your life. And you wouldn’t want an engineer who didn’t know the analysis tools that had been developed since graduation, or the cost-effective materials that had just come along. We just have to keep up. Learning never stops. Did this project help prepare you for the time when you will have to learn on your own, or did it inspire you to study new material?
One definition for compassion is an awareness of and sympathy for the suffering of another. Compassion means to recognize the suffering of another. But let’s look at a broader definition. Let’s define compassion as “the awareness of and sympathy for the suffering of another, and the desire to relieve that suffering.” What does that have to do with engineering? Simple! One of the things that engineers can choose to do in life is to look for and try to relieve suffering where they find it. Perhaps it means replacing an ancient water supply system that is leading to disease in some tiny village, or designing a communication system to protect seniors with illnesses, or designing prosthetic devices for crippled children. Even if we do not decide to make the relieving of suffering the focus of our life’s work, it is still critically important to our fullness as a human being that we feel compassion for the suffering. It is a part of the education that we hope you acquired at Santa Clara.
Conclusions (Last Chapter)
State what you learned from your work. In this section:
- Summarize what you did. This can be viewed as the evidence.
- State what you learned (the actual conclusions that you are drawing), and relate them to the project objectives.
- List the advantages and disadvantages of your work. In what ways is your solution deficient or lacking? You are not divulging a weakness in your work when you state problems that still remain.
- State directions for future work and list any open problems.
References (and Their Citations)
You must include a list of references that you cite to support facts that are not common knowledge or expert opinions that you include in your report. In general, it is better not to use a bibliography of sources consulted for general background knowledge; instead, make a habit of citing the sources that you actually use. The format of the citations (which appear within the body of your report), and the format of the list of references (that appears near the end of the report, just before the appendices) should follow the guidelines described in these documents.
Include complete source code listings, logic diagrams, parts lists, parts layout, data tables, background calculations, and other information needed for completeness, but would bog down the discussion in the body of the report.