Academic Writing and Presenting
Clear thinking becomes clear writing; one can’t exist without the other - William Zinsser
Academic Presenting¶
Apply the four-element theory to assess and improve technical presentations:
Air (Design & whitespace)¶
Ensure adequate whitespace on slides
Avoid clutter
Use the rule of three for structure
Create visual breathing room
Water (Story & flow)¶
Choose an appropriate story structure
Maintain logical progression
Ensure smooth transitions
Keep the audience engaged
Earth (Content & substance)¶
Every slide element must help users grasp the topic
Avoid information overload
Use visual cues instead of laser pointers
Maintain technical rigor
Fire (Delivery & passion)¶
Plan recording to include energy
Maintain appropriate enthusiasm
Use body language effectively
Connect with the audience
Presentation and Video Production Tools¶
Category | Tools | Purpose |
|---|---|---|
Presentation | LaTeX, LibreOffice Impress, PowerPoint | Creating slide decks |
Recording | OBS Studio | Mixing and recording video/audio |
Streaming | OBS Studio | Integration with conferencing tools |
Video Editing | ShotCut, OpenShot | Cutting and editing video |
Audio Editing | Audacity | Audio cleanup and editing |
Final Production | Handbrake | Encoding and format conversion |
Academic Writing¶
The Toulmin Method¶
The Toulmin method provides a framework for constructing rigorous, logical arguments - and consists of six components:
Claim: Main message to be conveyed
Grounds: Evidence supporting the claim
Warrant: Assumption linking grounds to claim
Backing: Information supporting the warrant
Rebuttal: Potential objections to the claim
Qualifier: Nuances or conditions restricting the claim
The ACCC Principles¶
The four principles of effective technical writing:
Accuracy: Both technical and linguistic precision
Clarity: Make the message effortless to understand
Conciseness: Eliminate waste; pretend each word costs money
Coherence: Ensure smooth flow at macro (structure) and micro (sentence) levels
Accuracy (Technical & Linguistic Precision)¶
Technical: Ensure all facts, data, and claims are correct
Linguistic: Use proper grammar, spelling, and syntax
Example: “Mobile Edge Computing paradigm is designed...” -> “The mobile edge computing paradigm is designed...”
Clarity (Effortless Understanding)¶
Don’t make the reader work too hard
Adapt jargon to audience
Define acronyms on first use
Example: “The flexibility measures available range from traditional ones...” -> “Flexibility measures range from traditional approaches (grid extension, pumped hydro) to advanced strategies like demand side management.”
Conciseness (Eliminate Waste)¶
Remove unnecessary words
Give greater visibility to key information
Example: “We have designed and implemented the Google File System, a scalable distributed file system...” -> “We designed and implemented the Google File System, a scalable distributed file system providing fault tolerance on commodity hardware.”
Coherence (Smooth Flow)¶
Macro-level: Follow predictable structure based on audience
Micro-level: Help reader follow along sentence-to-sentence
Example: Ensure each paragraph has a clear topic sentence
Identify and Correct Common Flaws¶
Flaw Type | Flawed Example | Corrected Version | Explanation |
|---|---|---|---|
Ambiguous Antecedent | When Sarah gave her sister her book, she was pleased. | When Sarah gave her sister Sarah’s book, the sister was pleased. | Unclear whether “she” refers to Sarah or her sister |
Lack of Parallel Structure | The tasks include writing proposals, to attend meetings, and budgeting time. | The tasks include writing proposals, attending meetings, and budgeting time. | All list items must use same grammatical form |
Number Mismatch | A comprehensive overviews were provided. | A comprehensive overview was provided. | Subject-verb agreement error |
Dangling Modifier | Running the diagnostic software, the error codes were unclear. | Running the diagnostic software, the technician found the error codes unclear. | Modifier must logically attach to subject |
Comma Splice | She writes well, she does not like to read. | She writes well, but she does not like to read. | Two independent clauses need conjunction |
Run-on Sentence | How do you correct run-on sentences it’s not as easy as it seems | How do you correct run-on sentences? It’s not as easy as it seems. | Independent clauses need proper punctuation |
Incorrect Article | We begin by discussing properties of sensor network. | We begin by discussing the properties of a sensor network. | Both nouns require articles based on specificity |
Relative Clauses¶
Restrictive Relative Clauses (Essential Information)¶
Use “that” (not “which”)
No comma before the clause
Removing the clause changes the meaning
Non-Restrictive Relative Clauses (Extra Information)¶
Use “which” (not “that”)
Comma before the clause
Removing the clause doesn’t change core meaning
Revision Strategies¶
Using Generative AI Tools (Proceed with Caution)¶
Do:
Use for formal revisions (grammar, style)
Check everything thoroughly
Document all AI use with prompts and responses
Use iteratively, maintaining human control
Don’t:
Let AI modify your content
Allow AI to stray from your original meaning
Use AI for content generation
Trust AI without verification
Using Search Engines (Google as a Writing Tool)¶
Search engines provide valuable insights into usage patterns:
Writing Checklist¶
Pre-Writing¶
Understand the State of the Art
Provide references to all sources
Identify target audience
During Writing¶
Be ultra-careful with abstract and introduction
Ensure macro-level cohesion
Provide evidence for original claims
Provide references for specialized knowledge
Keep sentences reasonably short (~20 words)
Grammar & Style¶
Ensure sentence accuracy
Maintain conciseness
Achieve clarity
Verify coherence
Check sentence length
Verify article usage
Use parallel structures
Clarify pronoun antecedents
Use correct relative clauses
Verify punctuation
Final Steps¶
Proofread thoroughly
Check consistency (UK vs US spelling)
Verify all citations
Ensure proper figure/table labels
Research Paper Structure¶
Section | Required | Notes |
|---|---|---|
Abstract | Yes | Always present |
Introduction | Yes | Always present |
Related Work | Yes | Always there, but position varies; may be before the conclusion |
Description of Contribution | No | Flexible structure; there may be a section on methodology |
Evaluation | No | Flexible structure; there may be a section on methodology |
Conclusion | Yes | Always there (there may also be acknowledgements in between) |
Bibliography | Yes | Always there (there may also be acknowledgements in between) |
Types of Academic Writing¶
Type | Description | Key Characteristics | |
|---|---|---|---|
Scientific Publications | Peer-reviewed journals, magazines, conferences | Surveys, position papers, research papers, book chapters | Rigorous peer review, evidence-based, structured |
Technical Reports | Internal or external documentation | Detailed methodology, results, conclusions | Often proprietary, less formal |
Theses | Hybrid between technical reports and scientific publications | Depends on adviser and institutional culture | Extensive literature review, original research |
Funding Proposals | Requests for research funding | Clear objectives, methodology, expected impact | Persuasive yet accurate |
Paper Reviews | Critical assessment of others’ work | Structured feedback (summary, strengths, weaknesses) | Anonymous, constructive |
Peer Review Process¶
Peer review is a critical component of academic quality control.
How Peer Review Works (Academic Context)¶
Definition: Having peers assess work prior to publication
Format: Always written, generally anonymous
Peers: People from the same field
Purpose: Quality control for conferences/journals
Limitation: Not always sufficient (lack of incentives)
Standard Review Structure¶
Paper Summary: Brief overview of content and contributions
Strengths: Positive aspects (implementation, results, hardware)
Weaknesses: Issues identified (readability, scientific motivation)
Detailed Comments: Specific, actionable feedback
Confidential Comments: For editors only
Glossary¶
- Toulmin Method
- A framework for constructing logical arguments, consisting of six components: claim, grounds, warrant, backing, rebuttal, and qualifier.
- ACCC Principles
- The four principles of effective technical writing: Accuracy, Clarity, Conciseness, Coherence.
- Restrictive Relative Clause
- A clause that provides essential information about the noun it modifies; uses “that” without a comma.
- Non-Restrictive Relative Clause
- A clause that provides extra, non-essential information; uses “which” with a preceding comma.
- Peer Review
- The process of having work evaluated by others in the same field prior to publication or acceptance.
- h-index
- Hirsh index; a bibliometric indicator: the maximum value of h such that an author has published h papers that have each been cited at least h times.
- Four Elements Framework
- A presentation improvement framework consisting of Air (design), Water (story), Earth (content), and Fire (delivery).
- Generative AI
- Artificial intelligence systems that can generate text, images, or other content; must be used cautiously in academic writing.