write right! right? - york universityim2c-canada.math.yorku.ca › ... › uploads › 2019 › 02...

37
Write right! Right? Robert Jordan B.Eng, B.Sc Honours, B.Ed, OCT# 639674 This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. Principles of Report Writing: Structure, Tools, Tips.

Upload: others

Post on 05-Jul-2020

3 views

Category:

Documents


0 download

TRANSCRIPT

Robert Jordan B.Eng, B.Sc Honours, B.Ed, OCT# 639674

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

Write to express, not to impress.

~ Gregory Ciotti

Vigorous writing is concise. A sentence should contain no unnecessary words, a paragraph no unnecessary sentences, for the same reason that a drawing should have no unnecessary lines and a machine no unnecessary parts. This requires not that the writer make all his sentences short, or that he avoid all detail and treat his subjects only in outline, but that every word tell.

~ W. Strunk Jr. and E.B. White, Elements of Style, 3rd ed. (Needham Heights, MA, Allyn & Bacon, 1979), p. 23.

In support of

Image Sources:< https://www.kent.ac.uk/careers/pics/application-form.GIF >

The Creative Process vs.

The Writing Process

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

In support of

image source: <http://www.carlalaureano.com/wp-content/uploads/2014/07/the-creative-process-clean.jpg>This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

In support of

adapted from image source: <http://www.lirvin.net/WGuides/recursive2.jpg>

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

The Writing ProcessIn support of

There is so much to do today!

I am just going do _______ today!

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

The Productive Procrastination mindset

In support of

Enough worry and procrastination. Just Write!

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

• Starting is the hardest part. • Plan time just to write, without distractions. • Remember writing is non-linear! • Spell and grammar check later! • Use “comments” to keep track of source

information.

In support of

When in doubt, cite.You must cite a reference when you: • Discuss, summarize, or paraphrase the ideas of an author • Provide a direct quotation • Use statistical or other dataCommon knowledge does not require citation.

.

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

In support of

Core Components of an APA Reference:

image source: <https://www.mendeley.com/guides/apa-citation-guide>

CitationsIn support of

- using another person’s ideas or words as their own.

What is Plagiarism?

“Top Individual Sources Plagiarized by Students

Among papers from secondary students, Wikipedia was used in 7.99 percent of the cases of matched text, just beating out Yahoo Answers, which came in at 7.55 percent. The remainder of the top five individual sources for plagiarism among secondary students included Answers.com (3.37 percent), eNotes (2.9 percent), and Slideshare (2.38 percent).”

Source: https://campustechnology.com/articles/2011/11/03/wikipedia-tops-list-of-plagiarized-sources.aspx

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

In support of

The author of the quotation has made a spelling error!Acknowledge the error it by writing [sic] after the word.“Plagiarism - DONT[sic]! • If you copy text put it in quotation marks and cite the source. • Do not copy proofs of theorems unless it is really necessary for the thesis. • Your examiners will be particularly alert to plagiarism.” (1)

(1) Freitag, M. A. (2012, February 3). How to write a good (maths) Ph.D. thesis. Retrieved March 09, 2018, from http://people.bath.ac.uk/mamamf/talks/awayday2012.pdf

Figure 1: Unknown painting, made into a grammar meme.

Image source: <https://www.grammarly.com/blog/sic/> citation style :=This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

In support of

Critical FriendIs the organization clear? coherent? Any content vague or unnecessary? Audience?

Leave time MORE writing and revising.

A great paper doesn’t write itself. A first draft should be unrefined but organized! Revisions bring clarity, brevity and logical flow of the paper.

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

Revising Editing

Image source: <http://img.viralnova.com/000/062/017/desktop-1406813083.png>

covfefe

Lets eat gramps.

In support of

cognitive load theory

Cognitive load for the reader.

Image source: <https://www.neilatkin.com/2018/01/18/cognitive-load-what-it-means-in-your-classroom-part-2/>Sweller, J. (2010). Cognitive load theory: Recent theoretical advances. In J. L. Plass, R. Moreno, & R. Brünken (Eds.), Cognitive load theory (pp. 29-47). New York, NY, US: Cambridge University Press.

(Sweller, 2010)

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

In support of

Clear and concise! Cognitive Load!adapted from:http://people.physics.illinois.edu/Celia/Lectures/Fluff.pdf

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

Revising Techniques

• Remove needless complexity • Important information first • Refine sentences • Remove redundancy • Detail when required

In support of

Writing Resources

https://columbiacollege-ca.libguides.com/apa

https://academicguides.waldenu.edu/writingcenter/scholarlyvoice/writingconcisely

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

In support of

Writing Mathematics

Improvements ?

example from <http://web.cs.ucdavis.edu/~amenta/w10/writingman.pdf>This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

In support of

example from <http://web.cs.ucdavis.edu/~amenta/w10/writingman.pdf>

A Guide to Writing Mathematics Dr. Kevin P. Lee

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

In support of

6 Basic Rules for Making Charts and Graphs

image source <https://i0.wp.com/flowingdata.com/wp-content/uploads/2010/07/0-basic-graph1.jpg?w=550&ssl=1>This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

In support of

Check the data Include Units

Explain encodings Label axes

Include your sources Consider your audience

Image source <https://i0.wp.com/flowingdata.com/wp-content/uploads/2010/07/0-basic-graph1.jpg?w=550&ssl=1>

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

In support of

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

In support of

https://www.darkhorseanalytics.com/blog/data-looks-better-naked

The art of writing science“Writing the clearest, easiest to read papers possible is the one-and-only goal. And there is no single ‘‘right way’’ to do this that fits all stories under all circumstances. Remember: writing is an experimental science. Just keep experimenting until you find a way that works for the task at hand.”

Plaxco, Kevin W. “The Art of Writing Science.” Protein Science : A Publication of the Protein Society 19.12 (2010): 2261–2266. PMC. Web. 15 Aug. 2018.

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

In support of

References“Framework for Success in Postsecondary Writing”. (n.d.).Retrieved from https://www.nwp.org/img/resources/framework_for_success.pdf

Westervelt, Mary. (n.d.). Concise Writing: Sentence Structure and Wording, Retrieved from http://www.seas.upenn.edu/faculty/tech-comm/pdf/Concise-writing.pdf

“How to Write Clear, Concise, and Direct Sentences”.(n.d.). Retrieved from https://writing.wisc.edu/Handbook/Clear,_Concise,_and_Direct_Sentences.pdf

Elliott, Celia M. (2016,4,6). Fluff in Scientific Writing. Retrieved from http://people.physics.illinois.edu/Celia/Lectures/Fluff.pdf

Kelley, Nicole. (2006). Sentence Structure of Technical Writing, Retrieved from http://web.mit.edu/me-ugoffice/communication/technical-writing.pdf

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

In support of

Lee, Dr. Kevin P. A Guide to Writing Mathematics.(n.d.). Retrieved from http://web.cs.ucdavis.edu/~amenta/w10/writingman.pdf

“Online Writing Lab (OWL)”,(n.d.). Retrieved from https://owl.english.purdue.edu/owl/

“APA Format Citation Guide”. (n.d.).Retrieved from https://www.mendeley.com/guides/apa-citation-guide

“How to Format Graphs, Charts & Figures in APA”. (n.d.). Retrieved from http://www.trinewrite.com/wp-content/uploads/2016/07/HowtoFormatGraphsChartsFiguresinAPA.pdf

“APA Citation Guide (6th edition): Images, Charts, Graphs, Maps & Tables”. (n.d.). Retrieved from https://columbiacollege-ca.libguides.com/apa/images

“APA: TABLES AND FIGURES”. (n.d.). Retrieved from http://psych.utoronto.ca/users/reingold/courses/resources/handouts_apa/TablesFigures1.pdf

“Scholarly Voice: Varying Sentence Structure”. (n.d.). Retrieved from https://academicguides.waldenu.edu/writingcenter/scholarlyvoice/sentencestructure

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

In support of

LaTeX vs. WYSIWYG

Image Source:<https://www.slideshare.net/MohamedAlrshah/latex-workshop-essentials-and-practices>

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

In support of

 Open a browser

https://www.overleaf.com?r=7e57751c&rm=d&rs=b

 Register

 Let’s start from their example.

TikZ and PgfPlots

In support of

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

Team’s Control Number SummaryIntroductionThe Model The Solutions Testing Results Strengths and WeaknessFuture WorkReferences

Math Modeling ReportIn support of

\section{ }

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

\author{ }

Add a numbered mathematical equation:

\begin{equation}\label{eq:integer} your equation

\end{equation} Add a reference to that numbered equation: Equation~\ref{eq:integer}, ™

In support of

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

From LATEX Math for Undergrads template:

\usepackage{amsmath, amssymb}

Add the AMS packages to preamble

In support of

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

Missing a Table of Contents.

\newpage \tableofcontents \newpage

just after

\maketitle ™

In support of

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

Add a List of Figures. Add

\listoffigures\newpage

just after

\newpage \tableofcontents \newpage ™

In support of

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

Put the References on a page of its own!

Add a Table!

In support of

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

Playtime

Things to try:

• add math specific packages (ams*) • play with formatting the Table • add another image • add another bibliographic entry to “dot”.bib

• google scholar, or journal database • remove section numbers • format a long equation. \begin{split}

In support of