WritingAboutEngineeringandTechnology and ComputerScience

I.GeneralInformation and Audience

Engineersusethelanguageofmathematics,themethodsofscience,andtheexperiencesofsociety.Theydesigntools,machines,processes,orsystemstosolveproblemsandaccomplishtasksefficiently.Writingisoftencollaborativeandcreatesreportsandrecommendationsbasedonresearchanddesignideas;devisestechnicalreports;andprovidesrealsolutionstorealproblems.Thefieldofengineeringincludesindustrial,mechanical,chemical,electrical,civil,geological,environmental,aerospace,andcomputerengineers.Audiencesincludeotherengineers,decisionmakers,policyexperts,schooladministrators,governmentleaders,corporateclients,andthegeneralpublic.Researchanddesignoccursinuniversities,non-profitresearchinstitutions,privateindustryandgovernment.

II.TypesofWriting

  • ProjectNotebook
  • Signedanddatedpersonaljournal,recordofprogresswith observations,datafromexperimentsanddesignprocess;explanationsorinterpretationsofdata
  • Descriptionofmaterials,procedures,designs;notesoftests
  • Reflectionson readings,meetings,logistics,peers’commentsorcritiques
  • LaboratoryReports
  • Procedures,materials,resultsofexperiments
  • Posequestionorproblem;backgroundinformation,objectiveoflabwork,step-by-stepprocedures
  • Description,commentary,explanationofresults;patterns,futureimplications,unansweredquestions
  • Differencesbetweenexpectationsandresults
  • TechnicalReports
  • Structureandfunctionsofdesign
  • Executivesummary(1-page,concisestatementofimportantpointsofreport)
  • Introduction/Purpose and Goals/ Methods/Data/Recommendations/Conclusion/Appendices/tables,charts,spreadsheets,maps,figures,illustrations
  • Proposals
  • Fundingfromacademicorgovernmentsources;descriptionofprojectforpotentialclients
  • Backgroundandrationaleforproject,includingneedaddressed
  • Materialsandmethods(taskdescriptions);methodofevaluation; expectedoutcomes
  • Organization plan/ short paragraphs about project staff
  • Timeline and itemized budget with deadlines; résumé
  • Progress Reports
  • Business letter/ memo of work completed
  • Project description; summary of progress; problems encountered; solutions designed or suggested; alterations to deadlines or budget; work remaining
  • Articles for publication in journals
  • Presentations

*NOTE:Computerengineersdonot typicallywritelabreportsorprojectjournals;theydo,however,writecodedocumentationandusermanuals.

III.TypesofEvidence

  • Datafromlabreportspublishedbyotherengineers
  • Quantitativedata(countable)andqualitativedata(observable)
  • Observationsandmeasurementsinsidelaboratory
  • Frombuildingmodelsofprojects
  • Computersimulations andmodels
  • Inreal-worldsettings

IV.WritingConventions

  • Usespecializedvocabularyandtechnical detail.
  • Collaborationisoftenrequiredinresearchandlabwork.
  • Usestandardsectionsforeachtypeofwritingwithheadingsand subheadingsinreportsandproposals.
  • Providevisuals: diagrams,charts,tables,graphs,andillustrations.
  • Usepasttenseforlabreports;futuretenseforproposals;presentand pastinprogressreports.
  • Use3rdpersonandactivevoice(trytoavoidpassivevoice).
  • Minimizeuseofacronyms;useonlythemostoften cited.
  • Writingmust be brief,clear,andlogicallyordered.
  • Othersneedtoreplicateworkandconfirmresults.

V.DocumentationStyle

  1. CMS(ChicagoManualofStyle)
  2. IEEE(InstituteofElectricalandElectronicsEngineers):IEEEEditorialStyleManual
  1. USGS(UnitedStatesGeologicalSurvey):SuggestionstoAuthorsoftheReportsoftheUnitedStatesGeologicalSurvey,7thedition(1991)
  2. Citereferencesinstylerecommendedbyprofessorororganization.
  3. ComputerengineerstypicallyuseLaTeX,adocumentpreparationsystem.

*****

Source consulted

Cullick,JonathanS.andTerryMyersZawacki.WritingintheDisciplines:AdviceandModels.

Bedford/St.Martin’s,2011.D-59-67.