Lec 12 ASUx48 Chp 5 Common Reports Fall 2024 PDF

Ain Shams University ICHEP - Fall 2024 Faculty of Engineering Scientific Research Prepared by ASUx48 (ByLaw 2023) Dr. M ElBanna  Ain Shams University ICHEP - Fall 2024...

Ain Shams University ICHEP - Fall 2024 Faculty of Engineering Scientific Research Prepared by ASUx48 (ByLaw 2023) Dr. M ElBanna  Ain Shams University ICHEP - Fall 2024 Faculty of Engineering Lecture 12 (Chapter 5) " Writing Common Engineering Documents " Presented by Dr. M ElBanna mm.elbanna @eng.asu.edu.eg  PRESENTATION OUTLINES This lecture discusses the contents and the format of some common types of reports: 1. Inspection and trip reports 2. Laboratory and field reports 3. Specifications 4. Proposals 5. Progress reports 6. Instructions 7. Recommendation reports ASUx48 @D M EL-Banna Fall 24 3  1. INSPECTION AND TRIP REPORTS These are short reports, whose function is to 1. Report on the inspection of a site, facility or property. 2. Summarize a business trip. 3. Report on an accident, describing the problem, discussing the causes and effect, and explaining how it can be avoided. ASUx48 @D M EL-Banna Fall 24 4  1. INSPECTION AND TRIP REPORTS Contents and organization: 1. Introduction 2. Background 3. Factual Discussion 4. Actions Taken 5. Interpretive, Evaluative, or Advisory Discussion ASUx48 @D M EL-Banna Fall 24 5  1. INSPECTION AND TRIP REPORTS ASUx48 @D M EL-Banna Fall 24 6  2. LABORATORY AND FIELD REPORTS The function of this report is to 1. Report on an experiment, test, or survey. 2. Present the data collected, discuss the theory, method, or procedure. 3. Discuss conclusions, and explore applications of the findings or possibilities for further research. ASUx48 @D M EL-Banna Fall 24 7  2. LABORATORY AND FIELD REPORTS Contents and organization: 1. Introduction 2. Background, theory. 3. Equipment 4. Method, Procedure 5. Observations, Data, Findings, and Results 6. Conclusions 7. Implications and Further Research 8. References ASUx48 @D M EL-Banna Fall 24 8  2. LABORATORY AND FIELD REPORTS ASUx48 @D M EL-Banna Fall 24 9  3. SPECIFICATIONS The function of this report is to 1. Provide detailed requirements for a product to be developed or detailed descriptions of an existing product. 2. Provide specifics on design, function, operation, and construction. ASUx48 @D M EL-Banna Fall 24 10  3. SPECIFICATIONS Contents and organization: 1. Use headings, lists, tables, graphics and identifying numbers to make individual specifications easy to find. 2. For organization, use the following techniques: General description Part-by-part description General-to-specific order ASUx48 @D M EL-Banna Fall 24 11  3. SPECIFICATIONS ASUx48 @D M EL-Banna Fall 24 12  3. SPECIFICATIONS ASUx48 @D M EL-Banna Fall 24 13  4. PROPOSALS The function of this report is to 1. Seek a contract, approval, or funding to do a project; function as a competitive bid to get hired to do a project. 2. Promote you and your organization as a candidate for a project. 3. Promote the project itself, showing why it is needed. ASUx48 @D M EL-Banna Fall 24 14  4. PROPOSALS Contents and organization: 1. Introduction 2. Background 3. Actual Proposal Statement 4. Description of the Work Product 5. Benefits and Feasibility of the Project 6. Method or Approach 7. Qualifications and References 8. Schedule 9. Costs 10. Conclusion ASUx48 @D M EL-Banna Fall 24 15  4. PROPOSALS ASUx48 @D M EL-Banna Fall 24 16  4. PROPOSALS ASUx48 @D M EL-Banna Fall 24 17  5. PROGRESS REPORTS The function of this report is to summarize 1. How your project is going 2. What you and your group has accomplished 3. What work lies ahead 4. What resources have been used 5. What problems have arisen. ASUx48 @D M EL-Banna Fall 24 18  5. PROGRESS REPORTS Contents and organization: 1. Introduction 2. Project description 3. Progress summary 4. Problems encountered 5. Changes in requirements 6. Overall assessment of the project. ASUx48 @D M EL-Banna Fall 24 19  5. PROGRESS REPORTS ASUx48 @D M EL-Banna Fall 24 20  6. INSTRUCTIONS The function of this report is to 1. Explain how to perform certain tasks. 2. Provide procedures on using equipment. 3. Give troubleshooting and maintenance guidelines. 4. Explain policies and operating procedures. ASUx48 @D M EL-Banna Fall 24 21  6. INSTRUCTIONS Contents and organization: 1. Introduction 2. Special notes (Note, Attention, Caution, Danger) 3. Background 4. Equipment and supplies 5. Structure of the Instructions 6. Discussion of the steps. 7. References ASUx48 @D M EL-Banna Fall 24 22  6. INSTRUCTIONS ASUx48 @D M EL-Banna Fall 24 23  6. INSTRUCTIONS ASUx48 @D M EL-Banna Fall 24 24  7. RECOMMENDATION REPORTS The function of this report is to 1.Study a situation or problem 2.Report on various alternatives or options 3.Recommend the best one 4.Assess the feasibility of an idea. ASUx48 @D M EL-Banna Fall 24 25  7. RECOMMENDATION REPORTS Contents and organization: 1. Introduction 2. Background on the situation 3. Requirements 4. Technical Background 5. Description 6. Point-by-point Comparisons 7. Conclusions (summary) 8. Recommendations 9. References ASUx48 @D M EL-Banna Fall 24 26  7. RECOMMENDATION REPORTS ASUx48 @D M EL-Banna Fall 24 27  7. RECOMMENDATION REPORTS ASUx48 @D M EL-Banna Fall 24 28  7. RECOMMENDATION REPORTS ASUx48 @D M EL-Banna Fall 24 29  IMPORTANT NOTES Don’t get hung up on the names of reports. Find out your company’s requirements. Think creatively about content and organization. Build your reports on the needs of the audience. Be careful with discussion of technical background. Be careful with the report introduction. ASUx48 @D M EL-Banna Fall 24 30 Thanks for your Attention Any Questions Dr. M ELBanna [email protected]