4: Technical Writing
- Page ID
- 121539
\( \newcommand{\vecs}[1]{\overset { \scriptstyle \rightharpoonup} {\mathbf{#1}} } \)
\( \newcommand{\vecd}[1]{\overset{-\!-\!\rightharpoonup}{\vphantom{a}\smash {#1}}} \)
\( \newcommand{\id}{\mathrm{id}}\) \( \newcommand{\Span}{\mathrm{span}}\)
( \newcommand{\kernel}{\mathrm{null}\,}\) \( \newcommand{\range}{\mathrm{range}\,}\)
\( \newcommand{\RealPart}{\mathrm{Re}}\) \( \newcommand{\ImaginaryPart}{\mathrm{Im}}\)
\( \newcommand{\Argument}{\mathrm{Arg}}\) \( \newcommand{\norm}[1]{\| #1 \|}\)
\( \newcommand{\inner}[2]{\langle #1, #2 \rangle}\)
\( \newcommand{\Span}{\mathrm{span}}\)
\( \newcommand{\id}{\mathrm{id}}\)
\( \newcommand{\Span}{\mathrm{span}}\)
\( \newcommand{\kernel}{\mathrm{null}\,}\)
\( \newcommand{\range}{\mathrm{range}\,}\)
\( \newcommand{\RealPart}{\mathrm{Re}}\)
\( \newcommand{\ImaginaryPart}{\mathrm{Im}}\)
\( \newcommand{\Argument}{\mathrm{Arg}}\)
\( \newcommand{\norm}[1]{\| #1 \|}\)
\( \newcommand{\inner}[2]{\langle #1, #2 \rangle}\)
\( \newcommand{\Span}{\mathrm{span}}\) \( \newcommand{\AA}{\unicode[.8,0]{x212B}}\)
\( \newcommand{\vectorA}[1]{\vec{#1}} % arrow\)
\( \newcommand{\vectorAt}[1]{\vec{\text{#1}}} % arrow\)
\( \newcommand{\vectorB}[1]{\overset { \scriptstyle \rightharpoonup} {\mathbf{#1}} } \)
\( \newcommand{\vectorC}[1]{\textbf{#1}} \)
\( \newcommand{\vectorD}[1]{\overrightarrow{#1}} \)
\( \newcommand{\vectorDt}[1]{\overrightarrow{\text{#1}}} \)
\( \newcommand{\vectE}[1]{\overset{-\!-\!\rightharpoonup}{\vphantom{a}\smash{\mathbf {#1}}}} \)
\( \newcommand{\vecs}[1]{\overset { \scriptstyle \rightharpoonup} {\mathbf{#1}} } \)
\( \newcommand{\vecd}[1]{\overset{-\!-\!\rightharpoonup}{\vphantom{a}\smash {#1}}} \)
\(\newcommand{\avec}{\mathbf a}\) \(\newcommand{\bvec}{\mathbf b}\) \(\newcommand{\cvec}{\mathbf c}\) \(\newcommand{\dvec}{\mathbf d}\) \(\newcommand{\dtil}{\widetilde{\mathbf d}}\) \(\newcommand{\evec}{\mathbf e}\) \(\newcommand{\fvec}{\mathbf f}\) \(\newcommand{\nvec}{\mathbf n}\) \(\newcommand{\pvec}{\mathbf p}\) \(\newcommand{\qvec}{\mathbf q}\) \(\newcommand{\svec}{\mathbf s}\) \(\newcommand{\tvec}{\mathbf t}\) \(\newcommand{\uvec}{\mathbf u}\) \(\newcommand{\vvec}{\mathbf v}\) \(\newcommand{\wvec}{\mathbf w}\) \(\newcommand{\xvec}{\mathbf x}\) \(\newcommand{\yvec}{\mathbf y}\) \(\newcommand{\zvec}{\mathbf z}\) \(\newcommand{\rvec}{\mathbf r}\) \(\newcommand{\mvec}{\mathbf m}\) \(\newcommand{\zerovec}{\mathbf 0}\) \(\newcommand{\onevec}{\mathbf 1}\) \(\newcommand{\real}{\mathbb R}\) \(\newcommand{\twovec}[2]{\left[\begin{array}{r}#1 \\ #2 \end{array}\right]}\) \(\newcommand{\ctwovec}[2]{\left[\begin{array}{c}#1 \\ #2 \end{array}\right]}\) \(\newcommand{\threevec}[3]{\left[\begin{array}{r}#1 \\ #2 \\ #3 \end{array}\right]}\) \(\newcommand{\cthreevec}[3]{\left[\begin{array}{c}#1 \\ #2 \\ #3 \end{array}\right]}\) \(\newcommand{\fourvec}[4]{\left[\begin{array}{r}#1 \\ #2 \\ #3 \\ #4 \end{array}\right]}\) \(\newcommand{\cfourvec}[4]{\left[\begin{array}{c}#1 \\ #2 \\ #3 \\ #4 \end{array}\right]}\) \(\newcommand{\fivevec}[5]{\left[\begin{array}{r}#1 \\ #2 \\ #3 \\ #4 \\ #5 \\ \end{array}\right]}\) \(\newcommand{\cfivevec}[5]{\left[\begin{array}{c}#1 \\ #2 \\ #3 \\ #4 \\ #5 \\ \end{array}\right]}\) \(\newcommand{\mattwo}[4]{\left[\begin{array}{rr}#1 \amp #2 \\ #3 \amp #4 \\ \end{array}\right]}\) \(\newcommand{\laspan}[1]{\text{Span}\{#1\}}\) \(\newcommand{\bcal}{\cal B}\) \(\newcommand{\ccal}{\cal C}\) \(\newcommand{\scal}{\cal S}\) \(\newcommand{\wcal}{\cal W}\) \(\newcommand{\ecal}{\cal E}\) \(\newcommand{\coords}[2]{\left\{#1\right\}_{#2}}\) \(\newcommand{\gray}[1]{\color{gray}{#1}}\) \(\newcommand{\lgray}[1]{\color{lightgray}{#1}}\) \(\newcommand{\rank}{\operatorname{rank}}\) \(\newcommand{\row}{\text{Row}}\) \(\newcommand{\col}{\text{Col}}\) \(\renewcommand{\row}{\text{Row}}\) \(\newcommand{\nul}{\text{Nul}}\) \(\newcommand{\var}{\text{Var}}\) \(\newcommand{\corr}{\text{corr}}\) \(\newcommand{\len}[1]{\left|#1\right|}\) \(\newcommand{\bbar}{\overline{\bvec}}\) \(\newcommand{\bhat}{\widehat{\bvec}}\) \(\newcommand{\bperp}{\bvec^\perp}\) \(\newcommand{\xhat}{\widehat{\xvec}}\) \(\newcommand{\vhat}{\widehat{\vvec}}\) \(\newcommand{\uhat}{\widehat{\uvec}}\) \(\newcommand{\what}{\widehat{\wvec}}\) \(\newcommand{\Sighat}{\widehat{\Sigma}}\) \(\newcommand{\lt}{<}\) \(\newcommand{\gt}{>}\) \(\newcommand{\amp}{&}\) \(\definecolor{fillinmathshade}{gray}{0.9}\)Engineering can sometimes feel like the solving the problems and challenges of producing/collecting data. While those can sometimes feel like substantial hurdles, one of the biggest obstacles to engineering effectiveness is communication.
- How to plan to write
- Building the content including figures and organizing content into appropriate sections
- Pedagogy of writing, what is the process by which a writer produces their work?
- Environmental factors will influence content and effectiveness:
- Place: personal or collaborative space; background noise; lighting; posture as a result of comfort
- Time: before or after meal/sleep; hours or days before deadline; own rate of production
- Format: sketching on whiteboard or notepad; building digital images; typing in particular platform
- Mindset: enthusiasm for conveying content; pressure of approaching deadline; trust in collaborators
- Code-switching for audience
- Snap to friend: HW #3 tuf
- AI-inspired fluff: I found the challenges of Homework #3 insurmountable in the timeframe allotted...
- Conversational: Phooey (f*@<), HW #3 can't get done in time
- Process in small steps
- Writing does not require the sequential nature of reading
- The hardest work may be a short statement
- Time Spent ≠ Word Count
- Utilize prompts to formulate thesis/framework
- Environmental factors will influence content and effectiveness:
- Templates and collaboration tools
- Templates with structure and references pre-set
- Examples:
- ASME two-column format
- Word 365 built-in report formats
- Overleaf for LaTeX typesetting
- Indexing tools for dynamic connections:
- Use Word's cross-reference tool
- Embed image and caption within same text box to group elements
- Helps prevents dynamic movement when additional materials added prior
- Direct coding within LaTeX:
- \label{eq:descriptor} somewhere within the figure, equation, or table environment
- \ ref{eq:descriptor} when cross referencing within the paragraph of the document
- Use Word's cross-reference tool
- Presenting data
- Graph forms:
- Rectilinear: linear scale both directions
- Semilog: rapid growth on one (or more) axis
- Pie/Distribution: relative % outcomes
- Stair step/bar: grouped instances of histogram
- Polar: parametric equations
- Contour: 3D space representation
- Figure guidelines (modified list originally from Dunn & Davis 4th Edition: https://doi.org/10.1201/b22182 )
- All axes (horizontal, vertical, radial, whatever) should have descriptive variable labels with units in brackets or parenthesis (author-defined style).
- Range and significant figures of tick values should be appropriate for data being presented (e.g., eliminate unnecessary zeros after decimal).
- Background gridlines are suggested; at minimum, tick marks should be internal and large enough to indicate location of value.
- Experimental results should have individual markers for each data point but unique markers for different data sets.
- Some indication of error bars should be provided via uncertainty analysis or statistical methods; single error bar indicates uniform value across a data set, individual error bars on markers indicate variability of uncertainty.
- Analytical results with functional equations should have solid curves.
- Numerical results as a result of statistical trendline should have dashed curves.
- A legend should be present if multiple results are displayed within single graph.
- The overall figure should have an indexed caption that describes content separate from repeating axis labels.
-
Evaluate effectiveness of student-produced graphs
- Answer
-
Add texts here. Do not delete this text first.
- Graph forms:
- Writing Building Blocks
- Methodology and Approach
- Sufficient detail for replication, not step-by-step standard operating procedure manual.
- Use schematics, images, annotated diagrams to connect with the measurands, variables, and results.
- Example: Design-stage uncertainty of particular sensor: \( u_{device} = \pm \sqrt{u_{0}^{2}+u_{I}^{2}} \)
- Use narrative prose in paragraphs; lists would exist in tables that are described.
- Results and Discussion
- Only include pertinent tables and graphs; efficiency of content rather than quantity (i.e., multiple data sets on single chart).
- Do not repeat data in multiple formats in order to expand page count.
- Each figure should be explicitly described with an introduction, trend observed, and why it aligns with physical principle being explored.
- Break separate ideas into paragraphs; avoid single-sentence paragraphs.
- Scientific justification is the demonstration of learning, not the simple presence or style of the data.
- Abstracts (typically lead all technical papers; individual submission in MEE 390 instruction)
- Standalone summary: < 1 page
- Should give sufficient overview to judge relevance
- Primary components: title, authors, affiliation, funding, intro, methodology, results, conclusion
- Results: be specific but not quantitative
- Conclusion: summarize significance and next steps
- Uncertainty Section
- Combination of theory and experimental procedures
- Identify key uncertainty contributors that affects results
- Reporting should include sensitivity coefficient functions
- MathCAD pages or Matlab scripts are insufficient as stand-alone content; provide interpretation
- Formatting Features
- Include page numbers
- No title page unless collaborative abstract submitted
- Auto-generated TOC, List of Figures/Tables
- Captions: before tables (leads the reader to the numbers), after figures (to help interpret the picture they viewed). Do not simply repeat axis labels or table headings.
- Future sections incorporated following formulative practices
- Theoretical Development
- Build equations step-by-step, like textbooks.
- Define variables and cross-reference numbered equations when making substitutions.
- Clarify independent/dependent/measured variables that will influence the original forms.
- Introduction
- Contextualize the topic's importance to developing engineering knowledge beyond assigned task
- Include external references and real-world examples
- Organize ideas into logical paragraph flow
- Methodology and Approach
- Receiving feedback
- Avoid tears and self-doubt: the learning occurs from the practice.
- Note the elements or behaviors that may repeat even if only mentioned once or twice.
- Incorporate the changes as improvement in practice.
- Full text OER resource