This report is to
be typed in your own words. It must be submitted as a formal report with
a cover. Your diagrams must be neat and done with a straight edge or on
a computer. Remember, you are trying to make a good impression on your
boss.
Format:
(i) Title Sheet
University name, School name, Department
name, Name of the Project, Name of the Report, Your
Name, Number and Section of the Course,
Date of the Report, Professor's Name, GTA's Name.
(ii) Abstract
A one page summary of the entire report
including a description of the project, problems encountered, solutions
etc
(ii) Table of Contents
List each section by section number also
include the title of the section and the page number it begins on.
(iii) List of Illustrations
A complete list of all the titles of the
illustrations in the document by figure number and page number.
(iv) List of Tables
A complete list of all the titles of the
tables contained within the report by figure and page number.
1. Specifications
A formal statement of the specifications
of the product. What does the product do? What are the inputs?
What are the outputs? What equipment is
needed? What power is needed?
2. Theory of Operation
A top-down description of the project
including block diagram and a description of what each part of the project
does. Then describe in detail, the circuitry used in each part of
the project.
3. Circuit Diagrams, Layouts & Wire
Lists
This section contains a complete set of
all circuit diagrams, a physical layout of the entire project and a complete
wire list that details all the electrical connections used in the project.
4. SPICE Simulation
This section shows the schematics and
output plots of all circuit use in the project..
5. Testing Procedure
A description of the tests which will
be done on each part of the design to see if it meets specifications. Testing
procedures should be keyed to specifications as stated in 1 above. Testing
procedures to be performed on the entire product.
7. Users Manual
i) Operating Instruction
Describe the operation of the controls,
connectors and how to read any displays. Provide general operation information,
a functional check procedure, and basic applications for this project.
ii)Maintenance
This section contains information for
performing preventive maintenance, troubleshooting, and corrective maintenance
of the design. It also details the type of test equipment to be used when
maintenance is to be performed.
iii)Safety Precautions
It must also contain safety information
which the user must follow to ensure the safe operation of the circuit.
8. Electrical Parts List
A list of all electrical parts that includes
the circuit reference designator of the part, its name and specific description,
and its part number.
9. Mechanical Parts List
A list of all hardware used in the design.
10. Conclusions
Provide a general review and status statement
of the project. Be specific as to major events accomplished
and major events missed. If problems have
occurred indicate how they has been be resolved.
15. References
Include all reference material appropriately
documented. Include a copy or reference to any source material
which is being used as a guide to the
project.
16. Appendices
Include in the appendices such items as
specification sheets, voluminous data which could be of interest to the
reviewer, copies of relevant pages of
the log book, relevant reports etc.