Study Notes from Technical Report Writing and Presentation

Introduction

  • The growth of professionals in a business organization typically follows a defined career ladder.

    • Young graduates often start near the bottom, performing basic tasks under supervision.

    • These professionals gradually assume more complex tasks including design and report writing.

  • The duration of this initial learning phase, or "pupillage", varies based on individual ability, diligence, and initiative.

    • Professionals who are poor at data collection, analysis, or communication may remain at entry-level positions.

    • Conversely, competent individuals may become registered professionals and take on management roles.

Characteristics of Technical Writing

  • Technical writing transcends traditional engineering; it encompasses various fields like sciences, arts, and social sciences.

    • Defined as formal writing adhering to specific rules.

    • Uses straightforward language focused on objectivity and clarity, avoiding emotional appeal.

Teaching Technical Report Writing

  • Consensus among educators and professionals indicates that formal teaching of technical report writing is essential.

    • It is suggested that while some skills can be learned on the job, structured teaching provides invaluable benefits.

Student Responses:

  1. Department of Mechanical Engineering:

    • "This course has significantly improved my written presentations."

  2. Department of Electronic and Electrical Engineering:

    • “My skills in technical writing have greatly benefited my military career.”

  3. Department of Metallurgical and Materials Engineering:

    • "My formatting and style improvements will reflect positively in my grades."

  4. Department of Computer Science and Engineering:

    • "This course has structured my report presentations effectively."

Importance of Technical Writing in Employment:

  • Professionals write technical reports routinely on various operational aspects such as contracts and project implementation.

  • Good technical writing can critically affect business success.

  • The importance of formal technical writing education is supported by alumni experiences.

Writing Deficiencies

  • Common mistakes in professional writing often frustrate employers and undermine clarity.

  • Errors include:

    1. Indistinguishable Surnames: Common confusion occurs when surnames are improperly formatted or abbreviated.

    • Suggested formatting: use commas, capitalization, or underlining to clarify surnames.

    1. Frequent Spelling Errors: Common examples include "tittle" instead of "title" and "writting" instead of "writing".

    2. Sentence Structure: Examples include fragmented sentences and incorrect tense usage, resulting in confusing communication.

    3. Miscellaneous Mistakes: Errors such as incorrect use of auxiliary verbs, and lack of politeness in business correspondence.

    4. Errors in Form of Address: Misuse of personal pronouns and incorrect sentence structures can distort intended meaning.

  • Emphasis on Teaching Report Writing:

    • Structured writing instruction is necessary given the frequent deficiencies observed in technical reports from new graduates.

Chapter on Standard Report Formats

1. Report Layout

  • Report layout encompasses all elements from the front cover to the end of the document.

  • Key sections include:

    • Prefatory Section: Contains title page, table of contents, abstract, acknowledgements, etc.

    • Importance of well-organized prefatory elements.

    • Body of the Report: Starts with an introduction and includes literature review, methodology, results, and discussion.

    • Should be coherent and well-structured, allowing readers to track the research flow.

    • Appendix Section: Stores supplementary information, pertinent but not critical to the body of the report.

    • Report Binding: Protects and presents the document aesthetically, influencing first impressions.

2. Mechanical Accuracy

  • Discusses aspects like:

    • Paper Types: Use A4 with clean margins.

    • Margins: Standard margin settings include 38mm left margin and 25mm for the rest.

    • Spacing: Double spacing for text and appropriate indentation.

    • Paging: Different practices for prefatory elements and the main text.

    • Footnoting and Usage of Abbreviations: Correct use of abbreviations and footnoting is essential.

Literature Referencing

1. Background on Research

  • Importance of literature revision to establish the state of knowledge before proceeding with research.

  • Missteps in referencing prior knowledge can lead to wasted efforts in research.

2. Citing Literature

  • Purpose of Citing: To credit original sources and provide pathways for readers to verify and learn more.

  • Form of Citing:

    • Numerical Method: Widely recognized method in social sciences.

    • Author-and-Year Method: Popular in scientific disciplines, showcasing the author's name and publication year.

3. Listing References

  • Complete citation is vital for readers to locate original materials.

  • Formatting and consistency are paramount in reference lists (alphabetical for author-and-year, sequential for numeric method).

4. Electronic Referencing

  • With the rise of digital documentation, proper handling of electronic assets is paramount.

Oral Presentation

1. Importance of Oral Skills

  • Oral presentation is integral to academic achievement and professional success, requiring preparation, understanding of audience, and subject matter expertise.

2. Presentation Techniques

  • Different styles of preparation based on audience needs and context.

  • Importance of using graphical aids, clarity, and engagement strategies for effective delivery.