1. 1 EE10142 Electronic Laboratory Techniques Laboratory Notebooks (Logbooks) and Technical Reports Dr P J Leonard 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 Summary ● How to write lab books and technical reports. ● What is a lab book / technical report ● What is it's purpose. ● The structure. ● The content. ● Style.

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

4. 4 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.

5. 5 Laboratory Notebooks (at university) ●Logbooks have a dual function at university. ●The main purpose, referred to above. ●To provide a place for a brief 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)

6. 6 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).

7. 7 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 ofLabeled diagram of experimental ➢ Apparatus arrangement. Simple line diagram usually sufficient.

8. 8 Laboratory Notebooks Typical Layout for Each Experiment ➢ Experimental Details of how the work was performed. ➢ Method ➢ ➢ Measurements Direct recordings of instrument readings etc. (Do not first write onto scraps of paper.) ➢ Use tables, with the measurement units clearly shown. ➢ Show estimate of errors, if possible. ➢ Graphs Best plotted during the experiment so that anomalies can be detected immediately. ➢ Correctly title axes and annotate if morethan one curve shown.

9. 9 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.

10. 10 Technical Reports See Kirkup, “Experimental Methods”, Chapter 7. Type 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. 1. Captive 2. Professional 3. Casual

11. 11 Technical Reports Types of Reader 1Captive 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.

12. 12 Technical Reports- Types of Reader 2Professional 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 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.

13. 13 Technical Report Structure The structure of the report may vary. Read the instructions. A typical report comprises. 1. Title 1. Title 2. Abstract 2. Abstract 3. Introduction/Background 3. Introduction/Background 4. Method 4. Method 5. Results 5. Results 6. Discussion/Conclusions 6. Discussion/Conclusions 7. References 7. References 8. Appendices 8. Appendices

14. 14 Report Structure The Title To give a true impression of the subject of the report. Author’s Name and Date Should be obvious, but is often forgotten. Abstract Should be concise and show full scope of report, including objectives and conclusions. Should enable reader to decide if report would be of interest.

15. 15 Technical Reports Symbols & Introduction List of Symbols All symbols, abbreviations and acronyms used in the report should be listed and described. All symbols, abbreviations and acronyms used in the report should be listed and described.Introduction Brief 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”.

16. 16 Technical Reports Theory Section Theory Theory relevant to the work should be included. Theory relevant to the work should be included. Equations can be quoted provided you reference the source. Equations can be quoted provided you reference the source. Make sure there is enough information for the reader (define symbols etc) Make sure there is enough information for the reader (define symbols etc) Detailed mathematical derivations should be put in an Appendix. Detailed mathematical derivations should be put in an Appendix. Try to understand the theory yourself. Try to understand the theory yourself.

17. 17 Technical Reports Investigation The Investigation Gives clear and unambiguous statement of the work being reported. Gives 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”. Do not title this section “Body of the Report”.

18. 18 Technical Reports Analysis of the results & Conclusion Analysis of Results Discusses the data obtained, making reference to graphs and theoretical predictions. Discusses the data obtained, making reference to graphs and theoretical predictions. Mentions any estimated experimental errors and statistical confidence limits. Conclusions This is where authors make their point and state what they claim has been established. This 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.

19. 19 Technical Reports Other stuff... Acknowledgments Expresses thanks where necessary. Expresses thanks where necessary.References List in the numerical order in which they appear. List in the numerical order in which they appear. Use the “Numerical Method”. See Library publication “A guide to citing references” (on web). Use the “Numerical Method”. See Library publication “A guide to citing references” (on web).Bibliography Further literature on associated work that has not been used or mentioned in the report. Further literature on associated work that has not been used or mentioned in the report.Appendices Supplementary mathematical details and derivations. Supplementary tables of data. Supplementary mathematical details and derivations. Supplementary tables of data.

20. 20 Technical Reports Layout and Text Layout should generally follow order for structure given above. 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. 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). 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. 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. Study formal IEE papers or course lecture notes to get an idea of professional layout and writing style.

21. 21 Some advice ● Read any instructions thoroughly. ● Make sure you know what the tutor wants. ● If there are guide lines follow them. ● For example if there are marks for an “Aardvark opinion poll”. Make sure your report has a section on this. Make sure your report has a section on this.

22. 22 Acronyms ● Over use of acronyms can make a report hard to read. ● If you are going to use yet another acronym (YAA) make sure you define it. ● A table of acronyms is useful.

23. 23 Style ✔ Write in the third person. ✔ “The experiments were conducted” NOT “I conducted the experiments” ✔ No personal opinions ✔ “The results were excellent” ✔ Do not use non-quantifiable descriptions ✔ “The diode got very hot” ✔ Typically use the past tense (the reader will suspect something if you use the future tense!!!!)

24. 24 Style Be clear and concise Use short simple sentences. Avoid saying the same thing twice. Only say things one time.

25. 25 Summary  How to write lab books and technical reports.  What is a lab book / technical report  What is it's purpose.  The structure.  The content.  Style.

26. 26 THE END  Thank you for your attention.  Any questions?