Advanced Technical Writing

Advanced Technical Writing Lecture 3 Formal report

Contents • Basic Page Layout. • Preliminary Pages. • Text Pages. • Back Mater.

Basic Page Layout • Margins • Line Spacing • Line Spacing for Equations • Font Types • Font Size • Font Style • Page Number

1. Margins • Left and right 2.5 cm • Top and bottom 3.5 cm

2. Line Spacing • Single space the text. • Single space: table/figure caption • Single space appendix materials and tables. • Allow additional space above and below the equation to separate it from the text.

3. Font Types • Use proportional font -- Arial, Times New Roman, Courier New, … -- must use at least 12-point font.

4. Font Size • Text must be a minimum of 12-point. • Fonts 10-point not acceptable for body of report. • Fonts 8-,9-,or 10-point may be used for tables and appendix to accommodate the margins

5. Font Style • Any standard office font style is acceptable -- not script, italic, bold, characters with slant or different sizes. • Italic fonts may be used when appropriate. • Times Roman -- uses 13-point size. • Font size and style are the same for text and page number.

6. Page Number • Pages should be numbered consecutively, with numbers located in the upper right, lower right, or lower middle of the page. • The Introduction should begin with 1. • Before Introduction, use Roman numerals.

Generally appear in formal reports: Components in Formal Reports

Front matter • Front cover • Title page • Dedication page (optional) • Acknowledgment (optional) • Abstract • Table of Contents • List of Tables • List of Figures • List of Abbreviations • Foreword (optional) • Preface (optional)

Title Page • Title of document • Your name • Degree title - Course title • Major Subject • University name, city, country • Date (month, year) • Assign numeral i, but does not appear • Back of title page is empty

Dedication Page • Optional • Type the word DEDICATION • Insert two double spaced blank lines and begin the text-double spacing all lines.

Acknowledgment Page • Optional • Type the word ACKNOWLEDGMENT • Insert two double spaced blank lines and begin the text-double spacing all lines.

Abstract • Type the word ABSTRACT • Single space all lines • Must have • statement of the problem • exposition of methods & procedures • summary of the finding • Usually 150 to 250 words.

Table of Contents • Type TABLE OF CONTENTS List items followed with dotes and page number • Abstract • List of Tables • List of Figures • List of Abbreviations • and so on • Don’t list anything before the Table of Contents

Table of Contents Continue • Include all chapter heads-upper case • Subheads as they appear in chapter. • Generally no more than three levels of heads are used. If heads in any levels is listed, all headings of that levels must be listed. • List Appendices next • The Bibliography

Table of contents Example Abstract …………………………….. ….……... ….……….….....iii List of Figures ……………………… ….……...... …............iv List of Tables ……………………… ….…….. ………………..…..v 1 INTRODUCTION..……………… .…….. ……….…….…..1 2 BACKGROUND………………… ……………. …….……..… 3 3 METHODOLOGY ………………… ….…….. ….….….…...6 3.1 Selection of study area ……… ….……….. 8 3.2 Description of study series…….……....10 3.2.1 Pilgrim 1 ……………………………….….12 3.3 Time series analysis ………. ….…..…....14 4 DATA ANALYSIS AND INTERPRETATION .….…..20 5 CONCLUSION ……………….…………………………….……22 APPENDIX A ……………..……………………………….……..…23 References …………………..……………………….……….….24

List of Tables, Figures, and Abbreviations • List each one on a separate page with each table followed by dots and page number at the right margin. • Double space between each caption but single space captions longer than one line. • Number all tables/figures consecutively

Foreword • Optional introductory statement written by someone other than the author. • May discuss the purpose of the report. • May include background information

Preface • Optional written by the author. • Include the purpose, background, and scope of the report. • Specify the audience for whom the report to be given.

Text Pages • Introduction. • Materials and methods. • Results and discussion. • Conclusion

Text Pages Continue • Must be divided into chapters which could be sub divided and listed in the Table of Contents. • Use just boldface, just italic, or just underline any heading. • Single space all heading. • Each new chapter must start on a new page. • Avoid having a heading as the last line of text on a page.

I. Introduction • First paragraph should capture reader’s attention. • Should include • Statement of the problem • Motivations • Complete description of the project. • Mentioning each part of the report

II. Materials & Methods • Literature Review. • Theoretical Derivations. • State your assumptions clearly. • Step-by-step derivation. • Figures may be necessary. • Summary of the approach taken. • Software simulation, hand calculation, design and implementation, programming, or analytical derivations.

III. Results & Discussion • Software documentation. • Analysis of plots, charts and figures where each should be mentioned and discussed. • Explanation of the results • The punch line • How did it turn out? • Was it as expected?

III. Results & Discussion Continue • Did it turn out according to theory? • Were the results repeatable? • Do you understand the significant of the results? • The reader should know exactly what happened and why.

IV. Conclusion • Tie together any loose ends. • Summarize the whole report. • Should include • restatement of the problem • restatement of the goals • restatement of the approach taken • restatement of the results & their relevance • future works, extrapolation and possible applications for technology

Back Mater • Page numbers continue as Arabic numerals • Appendix • Bibliography or References • Glossary • Index (optional)

Appendix • Labeled as Appendix A, Appendix B, so on. • Observe the margins and the page numbering. • Include materials that are too long and technical or unnecessary in the appendix.

Bibliography • Single space all lines of each entry, but double space between entries. • Use numbered reference list. • At least three references should be given. • References include course notes, text books, journal articles, conference proceedings, and thesis.

Reference should include • author • title of work • title of journal or text • volume number • date • page number • publisher • publisher’s city

Bibliography Examples [1] Samir S. Soliman and Mandyam D. Srinath. Continuous And Discrete Signals And Systems,2nd ed. New Jersey: Prentice Hall, 1998 [2] Khotandzal A. and et al, “ Neural Networks--Generation Three,” IEEE Trans. Neural Networks, Vol. 8, No. 4, July 1997 [3] Alhanjouri, M., Hamdy, N., and Abou-Chadi, F., “Feature Analysis and Classification of the Human Chromosome Images”, Second International Conference on Intelligent Computing and Information Systems, 5-7 March 2005, Cairo, pp. 175-163. [4] The International Engineering Consortium, "Time Division Multiple Access (TDMA)", Nov. 2007. available at (http://www.iec.orgonlinetutorialsacrobattdma.pdf), last visit 12 Feb. 2008.

Glossary • List of selected terms on particular subject that are defined and explained. • Arrange alphabetically • Follow dictionary style.

Index • Alphabetical list of all the major topics discussed in the report. • Cites the pages where each topic can be found thus allows readers to find information on topics quickly and easily.

Title page example

Title page example TITLE OF THE SENIOR PROJECT BY YOUR NAME Senior Project submitted to the Electrical & Computer Engineering In partial fulfillment of the requirements For the degree Bachelor of Science, Electrical Engineering Specialization in: Communication Islamic University of Gaza Gaza, Gaza Strip July 2012

DEDICATION To my parents and to my family who made this accomplishment possible

ACKNOWLEDGMENTS First and foremost, I would like to thank the chairman of my committee, Dr. xxxxxx, for his support, outstanding guidance and encouragement throughout my senior project. I would also like to express my gratitude and appreciation to Dr. xxx for all the help and guidance he provided throughout my education, and to the other members of my instructors, Dr. xxxxxxx and Dr. xxxxxxxx. I would like to thank my family, especially my parents, for their encouragement, patience, and assistance over the years. I am forever indebted to my parents, who have always kept me in their prayers.

ABSTRACT Title of the senior project BY Your name The design of controllers for nonlinear systems in industry is a complex and difficult task. The development of nonlinear control techniques has been approached in many different ways with varied results. One approach which has been shown promise for solving nonlinear control problems is the use of XXXXXXXX XXXXXXXXXX

Table of Contents 1. INTRODUCTION ………..……………………….……………..…….…………1 1.1 Introduction ……...…………………….…………………….………..1 1.2 Literature Review …………………….……………………….……..3 1.3 Contribution ….………….………………..……………………….…….4 1.4 Outline of This Thesis……………….……………………………….5 2. CLASSICAL CONTROL SYSTEM.…..……………………………………...8 2.1 Background ..…..………..…………………….……..………...……8 2.2 Controller Design…………………………………….……….……….9 2.3 Proportional-Integral-Derivative ….………………………..11 3. DESIGNING PID CONTROLLER FOR NONLINEAR SYSTEM..14 3.1 Introduction ..………………………………………….……………….14 3.2 Inverted Pendulum Problem ..………………………………….15 3.3 Nonlinear case ..…..………….………………………………………17 3.4 linearization case….…………..………………..……………………19

Table of Contents Continue 7. CONCLUSION AND FUTURE RESEARCH …….…..99 REFERENCES ……………………..……………………….……..103 APPENDICES A. THE FUZZY RULES OF MAMDANI MODEL FOR INVERTED PENDULUM PROBLEM…….………….109 B. THE FUZZY RULES OF SUGENO MODEL FOR INVERTED PENDULUM PROBLEM …..…….……112 C. COMPUTER PROGRAMS ……………………………..115 D. PHASE PLAINS ……….…………………………..………121

LIST OF TABLES Table 3.1 Inverted Pendulum Parameter Values ……………21 Table 5.1 Inverted Pendulum Equations …….………..………..53 Table 5.2 Inverted Pendulum Parameter Values ……....…..54 Table 5.3 Fuzzy Associative Memory (FAM) ………….…..…..59 Table 5.4 Set of Input-Output Data for First Rule …….……70 Table 5.5 Finding Parameters of First Rule Using Least Square Method ………………………………………..….….70 Table 5.6 The Eigenvalues of Sugeno Fuzzy Control Using State Variable Feedback ……..……………….……...85

LIST OF FIGURES • Figure 2.1 Closed-Loop Controller …………………………..…………………………….…..8 • Figure 2.2 A PID Controller ……………………………………………...…………….…....…12 • Figure 3.1 PID Controller for Inverted Pendulum ………………..…..…………..…...18 • Figure 3.2 The Cart Position of the Inverted Pendulum (Nonlinear Case) ….….18 • Figure 3.3 The Position of the Inverted Pendulum (Nonlinear Case)……..……….19 • Figure 3.4 The Cart Position of the Inverted Pendulum (Linearized Case) …...22 • Figure 3.5 The Position of the Inverted Pendulum (Linearize Case)…………..…..23 • Figure 4.1 The Venn diagram of a fuzzy set ……………………….….……………….…..27 • Figure 4.2 Intersection of fuzzy sets A and B …………………………………..…..……29 • Figure 4.3 Union of fuzzy sets A and B …………………………..………………..…..…...29 • Figure 4.4 Complement of fuzzy set A ……………………………..……………………....30 • Figure 4.5 A bell-shaped membership function ………….. ..………………….....…..31 • Figure 4.6 A triangular membership function …………………….……………….....…31

GLOSSARY

CHAPTER 1 INTRODUCTION 1.1 This is a Section Heading This is a sentence to take up space and look like text. This is a sentence to take up space [1]. This is a sentence to take up space and look like text. 1.1.1 This is a Subsection Heading This is a sentence to take up space and look like text. This is a sentence to take up space [2]. This is a sentence to take up space and look like text.

BIBLIOGRAPHY

APPENDIX APPENDIX A THIS IS AN APPENDIX This is a sentence to take up space and look like text. This is a sentence to take up space and look like text. A.1 A Section Heading Inside an Appendix This is how equations are numbered in an appendix: This is a sentence to take up and look like textspace

Advanced Technical Writing