Motivation Writing Good Protocols Examples Tips for LaTeX Summary How to Write a Good Protocol Mathias Magdowski Chair for Electromagnetic Compatibility Institute for Medical Engineering Otto von Guericke University, Magdeburg 09. November 2016 Writing Good Protocols 1 Motivation Writing Good Protocols Examples Tips for LaTeX Summary Structure Motivation How to Write a Good Protocol? Content Style Good and Bad Examples Tips for LaTeX Diagrams with pgfplots Wiring Schematics with circuitikz Summary Writing Good Protocols 2 Motivation Purpose and principal components: I experimental procedure I observations I evaluation & discussion of results Motivation Writing Good Protocols Examples Tips for LaTeX Summary Motivation Protocols: I laboratory internships I research projects/degree theses I measurements/experiments in the working life Writing Good Protocols 4 Motivation Writing Good Protocols Examples Tips for LaTeX Summary Motivation Protocols: I laboratory internships I research projects/degree theses I measurements/experiments in the working life Purpose and principal components: I experimental procedure I observations I evaluation & discussion of results Writing Good Protocols 4 How to Write a Good Protocol? Motivation Writing Good Protocols Examples Tips for LaTeX Summary Content Protocol structure: 1. cover page 2. theoretical fundamentals 3. preparation of the experiment 4. experimental procedure and evaluation I number and content of each experimental part I test circuit I measurement data in tabular form I evaluation and discussion of results 5. literature / references 6. declaration of authorship 7. appendix (scanned original measurement data) Writing Good Protocols 6 Important: I stick to the template I fill in completely Motivation Writing Good Protocols Examples Tips for LaTeX Summary Cover Page Content: I university, institute, chair, course I topic, number and date of the experiment I group and adviser I colloquium, date of submit Writing Good Protocols 7 Motivation Writing Good Protocols Examples Tips for LaTeX Summary Cover Page Content: I university, institute, chair, course I topic, number and date of the experiment I group and adviser I colloquium, date of submit Important: I stick to the template I fill in completely Writing Good Protocols 7 Bad: I too general and too broad I too detailed derivation of formulas I copy from the instructions Motivation Writing Good Protocols Examples Tips for LaTeX Summary Theoretical Fundamentals Good: I fundamentals and equations for the procedure and evaluation I give sources I length: 1 to 3 pages Writing Good Protocols 8 Motivation Writing Good Protocols Examples Tips for LaTeX Summary Theoretical Fundamentals Good: I fundamentals and equations for the procedure and evaluation I give sources I length: 1 to 3 pages Bad: I too general and too broad I too detailed derivation of formulas I copy from the instructions Writing Good Protocols 8 Motivation Writing Good Protocols Examples Tips for LaTeX Summary Preparation of the Experiment Tips: I timely I don’t be too creative I check the script or exercise notes I If things get complicated, you are usually on the wrong way! Writing Good Protocols 9 Discussion: I anomalies, difficulties or peculiarities I accuracy, error sources, improvement opportunities Motivation Writing Good Protocols Examples Tips for LaTeX Summary Experimental Procedure and Evaluation Important: I follow the given subcategorization I introductory and transitioning sentences I give units correctly I number equations, figures and tables I remain accurate Writing Good Protocols 10 Motivation Writing Good Protocols Examples Tips for LaTeX Summary Experimental Procedure and Evaluation Important: I follow the given subcategorization I introductory and transitioning sentences I give units correctly I number equations, figures and tables I remain accurate Discussion: I anomalies, difficulties or peculiarities I accuracy, error sources, improvement opportunities Writing Good Protocols 10 see https://www.ieee.org/documents/ieeecitationref.pdf see http://www.emv.ovgu.de/ Motivation Writing Good Protocols Examples Tips for LaTeX Summary Literature / References Example: [1] Martha Davis, Kaaron J. Davis and Marion M. Dunagan. Scientific papers and presentations. Academic Press, London, Great Britain, 2012. http://dx.doi.org/10.1016/B978-0-12-384727-0.00001-X. [2] Lutz Hering and Heike Hering. How to Write Technical Reports: Understandable Structure, Good Design, Convincing Presentation. Springer-Verlag, Berlin, Heidelberg, 2010. http://dx.doi.org/10.1007/978-3-540-69929-3. Writing Good Protocols 11 see http://www.emv.ovgu.de/ Motivation Writing Good Protocols Examples Tips for LaTeX Summary Literature / References Example: [1] Martha Davis, Kaaron J. Davis and Marion M. Dunagan. Scientific papers and presentations. Academic Press, London, Great Britain, 2012. http://dx.doi.org/10.1016/B978-0-12-384727-0.00001-X. [2] Lutz Hering and Heike Hering. How to Write Technical Reports: Understandable Structure, Good Design, Convincing Presentation. Springer-Verlag, Berlin, Heidelberg, 2010. http://dx.doi.org/10.1007/978-3-540-69929-3. see https://www.ieee.org/documents/ieeecitationref.pdf Writing Good Protocols 11 Motivation Writing Good Protocols Examples Tips for LaTeX Summary Literature / References Example: [1] Martha Davis, Kaaron J. Davis and Marion M. Dunagan. Scientific papers and presentations. Academic Press, London, Great Britain, 2012. http://dx.doi.org/10.1016/B978-0-12-384727-0.00001-X. [2] Lutz Hering and Heike Hering. How to Write Technical Reports: Understandable Structure, Good Design, Convincing Presentation. Springer-Verlag, Berlin, Heidelberg, 2010. http://dx.doi.org/10.1007/978-3-540-69929-3. see https://www.ieee.org/documents/ieeecitationref.pdf see http://www.emv.ovgu.de/ Writing Good Protocols 11 Important: I resolution, contrast, brightness of the scan I visible signature of the adviser I no “scrap sheets” Motivation Writing Good Protocols Examples Tips for LaTeX Summary Appendix Content: I scanned original measurement data I other handwritten notes Writing Good Protocols 12 Motivation Writing Good Protocols Examples Tips for LaTeX Summary Appendix Content: I scanned original measurement data I other handwritten notes Important: I resolution, contrast, brightness of the scan I visible signature of the adviser I no “scrap sheets” Writing Good Protocols 12 see Guidance on the Preparation of Degree Theses Motivation Writing Good Protocols Examples Tips for LaTeX Summary Style protocol ^= small degree thesis Writing Good Protocols 13 Motivation Writing Good Protocols Examples Tips for LaTeX Summary Style protocol ^= small degree thesis see Guidance on the Preparation of Degree Theses Writing Good Protocols 13 Motivation Writing Good Protocols Examples Tips for LaTeX Summary Diagrams 200 (in V) ) t ( u 0 −200 sine wave-form Voltage, cosine wave-form 0 2 4 6 8 10 12 14 16 18 20 Time, t (in ms) Figure 1: Harmonic time course of a voltage with a frequency of 50 Hz and an effective value of 230 V Writing Good Protocols 14 Motivation Writing Good Protocols Examples Tips for LaTeX Summary Tables Table 1: Measurement data for a charging process Time, t in s 0 1 2 3 Voltage, U in V 0:00 1:26 1:73 1:90 Writing Good Protocols 15 Reference in the text: I “see Table 1” or “. is shown in Figure 1” I not “the following figure” Really bad: I JPEG compressed raster graphics for diagrams Motivation Writing Good Protocols Examples Tips for LaTeX Summary Diagrams and Tables Table captions (above) and figure captions (below): I self-contained and understandable I better too long than too short Writing Good Protocols 16 Really bad: I JPEG compressed raster graphics for diagrams Motivation Writing Good Protocols Examples Tips for LaTeX Summary Diagrams and Tables Table captions (above) and figure captions (below): I self-contained and understandable I better too long than too short Reference in the text: I “see Table 1” or “. is shown in Figure 1” I not “the following figure” Writing Good Protocols 16 Motivation Writing Good Protocols Examples Tips for LaTeX Summary Diagrams and Tables Table captions (above) and figure captions (below): I self-contained and understandable I better too long than too short Reference in the text: I “see Table 1” or “. is shown in Figure 1” I not “the following figure” Really bad: I JPEG compressed raster graphics for diagrams Writing Good Protocols 16 I insert cross references (e. g. “as shown in Section 3, . ” or “on Page 4”) I non-breaking spaces after Figure, Table, Page, Section, Equation, . and between numbers and units I hyphen vs. dash I no references as footnotes I see https: //en.wikipedia.org/wiki/Electronic_symbol Motivation Writing Good Protocols Examples Tips for LaTeX Summary Further Hints I introduce abbreviations and variables when used the first time Writing Good Protocols 17 I non-breaking spaces after Figure, Table, Page, Section, Equation, . and between numbers and units I hyphen vs. dash I no references as footnotes I see https: //en.wikipedia.org/wiki/Electronic_symbol Motivation Writing Good Protocols Examples Tips for LaTeX Summary Further Hints I introduce abbreviations and variables when used the first time I insert cross references (e. g. “as shown in Section 3, . ” or “on Page 4”) Writing Good Protocols 17 I hyphen vs. dash I no references as footnotes I see https: //en.wikipedia.org/wiki/Electronic_symbol Motivation Writing Good Protocols Examples Tips for LaTeX Summary Further Hints I introduce abbreviations and variables when