Technical Report Writing - Lecture 5 PDF
Document Details
Uploaded by GratifiedLogic5854
Menoufia University
Dr. Sondos Fadl
Tags
Summary
This lecture provides an overview of technical report writing, emphasizing scientific writing style and the structure of a scientific report. It covers elements like the title page, abstract, introduction, methods, results, discussion, and conclusion. The importance of concise, objective writing and proper use of technical terms are also stressed.
Full Transcript
Technical Report Writing Dr. Sondos Fadl Faculty of Computers &Information Technology Menoufia University Lecture 5 5. Scientific Writing Style A scientific report is a document that describes the process, and results of te...
Technical Report Writing Dr. Sondos Fadl Faculty of Computers &Information Technology Menoufia University Lecture 5 5. Scientific Writing Style A scientific report is a document that describes the process, and results of technical or scientific research or the state of a technical or scientific research problem. It might also include recommendations and conclusion of the research. You should write in complete, grammatically correct sentences. Scientific Writing Style If most of your sentences are long (4 or more 'clauses' or parts) you will confuse the reader. Consider making two sentences (with 3 or less parts in each) only using long sentences to include a qualification or an example. Be concise. If you can use one word instead of a phrase with two or more words, then choose the one word (get around = avoid). Be objective. Limit your use of personal pronouns (I, you, we), emotionally loaded words (wonderful, useless, lovely) Scientific Writing Style Use technical terms correctly. Learn what they mean, how to use them and how to spell them. Do not use contractions (isn't, doesn't, it's), While these are common in speech, in formal writing the full form (is not, does not, it is) is expected. Elements of a Scientific Report 1) Title Page 2) Table of Contents 3) Abstract 4) Introduction 5) Materials and Methods (Experimental) 6) Results 7) Discussion 8) Conclusion 9) References Title of the report: Usually 4-12 words in length. Should be short, specific and descriptive, containing the keywords of the report. Title page Authorship: Always publish under the same name. Include author addresses. Indicate the corresponding author and their contact details. Date: The date when the paper was submitted. Table of Contents A Table of Contents is only required for length reports Elements of (usually 6 pages or more). a Scientific Abstract Report The Abstract is a self-contained synopsis of the report - an informative summary of what you did and what you found out. The Abstract should include the following: Objectives and scope of the investigation. Abstract A brief reference to the Materials and Methods. A summary of the results and conclusions - a brief but thorough statement of the outcome/s of the experiment. If there is a hypothesis, you may state what it is and whether it was supported or refuted. The following should not be included in the Abstract: Literature citations. Formulae and abbreviations, references to tables. Although the Abstract comes first in a report, it is best to write it last, after you have the results and conclusions. Introduction The purpose of the Introduction is to put the reader in the picture and place the research/experiment within a context. The following may be included in the Introduction: Background about the analysis to be carried out. A brief review of previous research (relevant literature) to give a background - paraphrase relevant facts from the scientific literature, citing the sources to support each statement. Reason/s why the research was undertaken. Statement of the hypothesis (an idea or concept that can be tested by experimentation) if there is one. An explanation of the different techniques and why they are used. A statement of the objective/s - what you hope to achieve. The Introduction should answer the following questions: 1. What was the purpose or objective of the experiment/research? 2. Why was it important? 3. Why was the experiment/research conducted in a particular manner? The Introduction should not include any results or conclusions. Materials and Methods The Materials and Methods, sometimes called Methodology, is a description of the materials and procedures used - what was done and how. Describe the process of preparation of the sample, specifications of the instruments used and techniques employed. The Method should include such things as sample size, equipment used, experimental conditions, times, controls etc.. While the Method does not need to include minute details (e.g. if you followed a set of written instructions, you may not need to write out the full procedure - state briefly what was done and cite the manual), there needs to be enough detail so that someone could repeat the work. Do not keep using the word "then" - the reader will understand that the steps were carried out in the order in which they are written. Results This section states what you found. The following will be included in your Results: Pictures, Tables and graphs whenever practical. Brief statements of the results in the text (without repeating the data in the graphs and tables). When writing about each picture, graph or table, refer to it parenthetically e.g. (Figure 1, Table 3, etc.). If possible give a section of related results and then comment on them. Subheadings can be used to divide this section so that it is easier to understand such as Comparison, evaluation metrics, etc. Include only your own observed results in this section. Massive quantities of data or raw data (not refined statistically) can be presented in appendices. The following should not be included in your results: What you expected to find or what you were supposed to have observed. References to other works (published data or statements of theory). The Results section should be written in the past tense and passive voice, avoiding the use of "I" and "we". Discussion The Discussion must answer the question "What do the results mean?" State your interpretation of your findings; perhaps comparing or contrasting them with the literature, Reflect on your actual data and observations. Explain errant data or describe possible sources of error and how they may have affected the outcome. Conclusion This is the summing up of your experiment/research, and should relate back to the Introduction. The Conclusion should only consist of a few sentences, and should reiterate the findings of your experiment/research. If appropriate, suggest how to improve the procedure, and what additional experiments or research would be helpful. References Cite any references that you have used, ensuring that each item in the reference list has an in-text citation, and every in- text citation has a full reference in the reference list at the end of your paper. Ensure that the references are formatted according to the style required by the journal (or your lecturer/supervisor), and be careful with spelling (the author whose name you misspell may be asked to review the paper!) Practical Task Abstract This paper focuses on applying artificial intelligence (AI) algorithms to diagnose lung cancer from CT scan images as figure 1. Our model used convolutional neural networks (CNNs) trained on 500 images of lung tissue from database. We discovered that the model is very successful in detecting cancerous tissue with a great accuracy rate. The precision and recall scores were also really high, making it a reliable method. Additionally, the algorithm's performance was tested against other recent techniques in literature as in Table below, which yielded superior results. Method Detection rate Our 99% method Other 97% method Figure 1 Practical Task 1. Identify the Errors in the abstract 2. Rewrite the abstract after correct the errors 3. Give a suitable Title for that technical report and prepare the whole Title page