1. 1 EE10134 Electronic Laboratory Techniques Laboratory Notebooks (Logbooks) and Technical Reports Dr M J Balchin Refer to: Kirkup L, “Experimental Methods – An Introduction to the Analysis and Presentation of Data”, Wiley, 1994. ISBN: 0471335797. Univ. of Bath Shelf Marks: 530.001.5 KIR, Level-4. Notes below taken from above book.

2. 2 Laboratory Notebooks (Logbooks) See Kirkup, “Experimental Methods”, Chapter 1. Type of book. –A4 size, bound or stapled. Alternate pages lined and graph, or all lined - and glue in graph paper as required. PUT OWNER’S NAME ON THE BOOK. –Number the pages of the book. For reference purposes. To show that no pages have been added or removed (may be important in arguments concerning intellectual property rights).

3. 3 Laboratory Notebooks (Logbooks) Main purpose - place to keep a record of laboratory work. –Contains measurements, observations, development of experimental apparatus and techniques etc. –Sufficient detail should be recorded so that a full technical report can be written on the work at a later date. Logbooks have a dual function at university. –The main purpose, referred to above. –To provide a place for a brief technical technical report on an experiment for assessment purposes (marking). logbook must be legible to other readers must be laid out like a technical report (see later)

4. 4 Laboratory Notebooks (Logbooks) Logbooks have a single function in industry. –The main purpose, referred to above. Logbook need only be readable to its user (unless the engineering manager says otherwise).

5. 5 Laboratory Notebooks Typical Layout for Each Experiment DateEssential housekeeping TitleTo give a true impression of the subject of the work. Aim of the WorkExplains what you are trying to do. (This is usually given to you at university.) Description ofDescription of items used in the Apparatusexperiment. Record of instrument serial numbers etc. Sketch ofLabelled diagram of experimental Apparatus arrangement. Simple line diagram usually sufficient.

6. 6 Laboratory Notebooks Typical Layout for Each Experiment ExperimentalDetails of how the work was performed. Method MeasurementsDirect recordings of instument readings etc. (Do not first write onto scraps of paper.) Use tables, with the measurement units clearly shown. Show estimate of errors, if possible. GraphsBest plotted during the experiment so that anomalies can be detected immediately. Correctly title axes and annotate if more than one curve shown.

7. 7 Laboratory Notebooks Typical Layout for Each Experiment CalculationsIf needed, state formula used. Clearly describe steps taken. ConclusionsThis section not usually needed in a logbook. Can be used to briefly state what is claimed to have been established. Conclusions must only be drawn that are justified by the experimental evidence.

8. 8 Technical Reports See Kirkup, “Experimental Methods”, Chapter 7. Types of Reader A good technical report should present information in such way that it can be quickly and easily absorbed by the following classes of reader. 1Captive 2Professional 3Casual

9. 9 Technical Reports Types of Reader 1Captive reader - e.g. member of staff (or marker), engineering departmental manager etc Will read all of the report - especially the technical content. Make the job of reading easier by drawing clear diagrams and graphs, and by writing concisely and clearly.

10. 10 Technical Reports Types of Reader 2Professional reader - e.g. someone working in the area of activity of the report. Will be mainly interested in results and conclusions. Present these topics clearly to attract professionals. 3Casual reader - e.g. a professional reader whose attention you are trying to attract. Concentrate on attractive layout, and short and to-the- point abstract and summary.

11. 11 Technical Reports Report Structure The TitleTo give a true impression of the subject of the report. Author’s NameShould be obvious, but is often forgotten. and Date AbstractShould be concise and show full scope of report, including objectives and conclusions. Should enable reader to decide if report would be of interest. Abstract often rewritten after rest of report complete.

12. 12 Technical Reports Report Structure List of SymbolsAll symbols, abbreviations and acronyms used in the report should be listed and described. IntroductionBrief outline of background material (i.e. previous work in the area, information from references etc.). Used to help reader understand the purpose of the work reported. It is not a section giving a “procedure”.

13. 13 Technical Reports Report Structure TheoryParticular aspects of any theory which is in the work reported. References can be cited and some equations given. Detailed mathematical derivations should be put in an Appendix. The InvestigationGives clear and unambiguous statement of the work being reported. Actual title of this section will depend on the work being described. Do not title this section “Body of the Report”.

14. 14 Technical Reports Report Structure Analysis of ResultsDiscusses the data obtained, making reference to graphs and theoretical predictions. Mentions any estimated experimental errors and statistical confidence limits. ConclusionsThis is where authors make their point and state what they claim has been established. Conclusions must only be drawn that are justified by the experimental evidence described in earlier sections.

15. 15 Technical Reports Report Structure AcknowledgementsExpresses thanks where necessary. ReferencesList in the numerical order in which they appear. Use the “Numerical Method”. See Library publication “A guide to citing references” (on web). BibliographyFurther literature on associated work that has not been used or mentioned in the report. AppendicesSupplementary mathematical details and derivations. Supplementary tables of data.

16. 16 Technical Reports Layout and Text Layout should generally follow order for structure given above. Graphs, tables, diagrams etc. should all be given figure numbers (so that they can be referred to in the text) and brief titles. Ideally, text should written in the third person and past tense (see Kirkup for examples). Leave adequate margins. Break text up into convenient paragraphs, sub-sections and sections, as necessary. Study formal IEE papers or course lecture notes to get an idea of professional layout and writing style.