APPM 2460 Differential Equations Computer Lab

1
APPM 2460Differential Equations Computer Lab

• Writing Workshop I

2
Why Write?

• You will need writing every single day of your
  career
• Technical reports
• Documentation
• Office memos
• E-mail
• Software comments even!
• Even more important in Diffy-Q!

3
Fact The better a writer you are, the more
valuable you will be to any organization
It is often the case that your ability to
communicate your ideas persuasively is more
important than the ideas themselves
4
Writing Goals of Calculus Labs

• Learn basic technical writing skills
• Improve organization in writing
• Improve clarity and logic in writing
• Improve grammar and mechanics
• Improve writing style

5
Resources

• Calculus lab writing guidelines Follow them
  closely!
• On-line writing guide many examples
• OWL guaranteed improvement
• Many books and references

6
Organization

• Title Page
• Title of report
• Students names
• Date
• TAs name
• Recitation number

7
Organization

• Introduction
• States the purpose of the document
• Concise one or two paragraphs
• Relatively non-technical
• No complicated equations or problem background

8
Organization

• Body
• Main part or the report
• All required qualitative and quantitative results
• Contains prose, equations, and graphics
• Divided into sections with headings
• Look for logical places to make divisions
• Use descriptive heading titles

9
Organization

• Conclusion
• Restate the primary conclusions
• Brief but comprehensive
• Need not be too technical
• A place for general comments and reflections

10
Organization

• Appendix
• A place to put extra material too lengthy for the
  body
• Examples Extra graphs, lengthy calculations
• All data in appendix should be referred to in
  main body
• No major conclusions in appendix! Appendix
  should be able to be torn out and the paper still
  makes sense

11
Logic

• The goal is clarity
• Arguments should make sense
• Arguments should be as direct as possible

12
Logic

• Planning for clarity a procedure
• Read
• Compute
• Plan and write
• Re-read
• Edit and revise

13
Logic

• Read the lab
• Read the text of the lab carefully
• Understand the background
• Understand what is being asked of you

14
Logic

• Compute
• Do the math first
• Understand the technical difficulties
• Seek help with questions

15
Logic

• Plan and write
• Start with a plan!
• Think about the most logical way to describe the
  results you have produced
• One idea should lead clearly to the next
• Make an outline
• Write it up fill in the outline

16
Logic

• Re-read
• The only way to ensure clarity is to re-read
• You will catch mistakes large and small
• Enlist someone to help you
• OWL links from writing guidelines

17
Logic

• Edit and re-write
• Incorporate necessary changes
• Review your work again

18
Grammar and Spelling

• Proper spelling and grammar
• Use a spellchecker
• If you need grammar help, find someone to help
  you re-read and edit
• Grammar checkers can be useful, but hard to use
• Re-read and revise
• Refer to on-line writing guide and OWL

19
Mechanics and Format

• Neatness
• Labs must be typed (word processed)
• Print on 8.5 x 11 paper
• Long calculations can be hand written if need be,
  but only on 8.5 x 11 printer paper
• Dont use loose-leaf paper

20
Mechanics and Format

• Page format
• Use 1.5 line spacing
• Reasonable font - 12 points
• Margins no more than 1.25 inches

21
Mechanics and Format

• Graphics, equations, and tables
• Must be included in body of lab
• Must be LABELED!
• Graphs must have titles and labeled axes

22
Mechanics and Format

• Software
• Mathematica, Matlab, MVT to solve math problems
• Word processor for editing
• Can cut images from Mathematica, Matlab and paste
  into Word (MVT a bit harder)
• Use of other math software possible, but not
  supported by instructors or TAs

23
Style and Clarity

• Style - Persuasion in words
• Clarity
• Efficiency and concision
• Accuracy
• Goal get the ideas across with impact
• In technical writing clarity impact

24
Style and Clarity

• Concision
• Concise language is usually clear language
• Efficiency in word choice
• Efficiency in sentence structure
• Eliminate filler words that dont add meaning
• Replace long complicated sentences with short
  direct sentences

25
Style and Clarity

• Concision - examples

Wordy Decreasing the amount of background
noise would be an important thing to do since the
Real McCoy is used for a place of study as well
as an eating establishment.
Concise Decreasing background noise is
important since the Real McCoy is used for
studying as well as eating.
26
Style and Clarity

• Accuracy
• Technical writing must never be vague or
  misleading
• Give enough information to support claims
• Choose accurate words
• Avoid jargon wherever possible
• All acronyms should be written in full form on
  first use

27
Style and Clarity

• Accuracy - examples

Vague The stations are unorganized and do not
have proper battery moving equipment.
Accurate The stations are unorganized and do
not have proper equipment to efficiently swap out
a forklift battery.
28
Your Task

• Read the writing guidelines for Calculus labs
  http//amath.colorado.edu/courses/2460/2004Spr/res
  ources/writing.html
• Read the on-line writing guide for more
  information http//amath.colorado.edu/courses/24
  60/2004Spr/resources/guide.v1.pdf