Services & Resources / Wolfram Forums / MathGroup Archive
-----

MathGroup Archive 2011

[Date Index] [Thread Index] [Author Index]

Search the Archive

How to write a "proper" math document

  • To: mathgroup at smc.vnet.net
  • Subject: [mg119892] How to write a "proper" math document
  • From: "McHale, Paul" <Paul.McHale at excelitas.com>
  • Date: Tue, 28 Jun 2011 07:56:21 -0400 (EDT)

Hi,

I am an engineer who lacks the audacity to claim any special awareness in math, but do find what skills I have very useful.  One of the tasks engineers have is to leave a trail of bread crumbs for others to follow.  This document ends up being design calculations (minimally) and a process of discovery (ideally).  I have found myself and other engineers often understand what we are doing, but are far worse at communicating it.  I agree this indicates a gap in understanding to some degree.  I think it is also true that we can think of Moby Dick but don't have the proper writing skills to convey it as a novel.  The result is a mixture of ineffective writing styles to document work.

Does anyone have a set of rules or a style document for how to write a document that will be mathematically oriented?  I have found some information. A common set of tasks I do include:

Document(minimal)
1. Highlight original datasheet pdf using PDF XChange (free)
2. Use screen hunter to capture relevant part of PDF and past into notebook
3. Use above information to as input data to perform calculations
4. Mix calculations with explanation of what and why

Discovery(ideal)
1. Describe existing solution or foundation from which we are going to extrapolate
2. Explain (charts, data, verbage) why this is insufficient
3. Show what we are changing to achieve better results

Maybe the discovery could almost be called a white paper.  What I am looking for is rules such as when to refer to an equation by number (can Mathematica do this?) or when we should just "in line" the equation within a sentence.  Any such rules would be appreciated.  Once document I have found is:

http://ems.calumet.purdue.edu/mcss/kevinlee/mathwriting/writingman.pdf

While very good, it is not mathematica centric.  I.e. Is there way to quickly open and close cells since programming cells reduce document readability for the Mathematica un-challenged :).

I'm sure there is much more to the Mathematica front end than what I am using.



Paul McHale  |  Electrical Engineer, Energetics Systems  |  Excelitas Technologies Corp.

Phone:   +1 937.865.3004   |   Fax:  +1 937.865.5170   |   Mobile:   +1 937.371.2828
1100 Vanguard Blvd, Miamisburg, Ohio 45342-0312 USA
Paul.McHale at Excelitas.com
www.excelitas.com



Please consider the environment before printing this e-mail.
This email message and any attachments are confidential and proprietary to Excelitas Technologies Corp. If you are not the intended recipient of this message, please inform the sender by replying to this email or sending a message to the sender and destroy the message and any attachments.
Thank you



  • Prev by Date: Re: what's in a name? (legal and conventional constructions of identifiers)
  • Next by Date: Re: Stylesheet questions
  • Previous by thread: How substitute ToNumberField by LatticeReduce
  • Next by thread: Re: How to write a "proper" math document