Basic Tech Writing Tips

0

No comments posted yet

Comments

Slide 1

SCIENTIFIC AND TECHNICAL WRITING BASICS

Slide 2

Basic Components of a Report Title Abstract Overview/ Intro/Background Problem Statement Alternatives Evaluation Process Results and Selected Design Conclusion and Supplements

Slide 3

REPORTS ARE SEGMENTED Real divisions of information that can stand alone.

Slide 4

Start by Knowing Your AUDIENCE WHO?

Slide 5

Be Flexible As Audiences Change Change Perspective (marketing v shipping) Change Tone (Engineer v. City Council) Change Content Interest levels/Technical Knowledge Supplements and Appendices

Slide 6

AUDIENCE What do they care about? $, Time, etc What do they know? Tech Knowledge 1 2 3 4 5 What basic facts MUST they understand?

Slide 7

Second, Know Your PURPOSE Win a Contract ? Present Options? Explain Problems? Progress Report? Defend work?

Slide 8

BIG PICTURE

Slide 9

BIG PICTURE Design Approach Thought Process

Slide 10

PURPOSE?

Slide 11

Brand

Slide 12

Clients Do $$ Brands and Ideas (sometimes without a lot of details)

Slide 13

ONCE YOU KNOW Audience Purpose

Slide 14

ORGANIZE YOUR IDEAS

Slide 15

Write.

Slide 16

EDIT TURN ON GRAMMAR AND SPELLING CHECKER. USE IT. ALWAYS.

Slide 17

REVISE It takes longer than you think it will.

Slide 18

GROUP WRITING ALWAYS unified Tone or Voice Verb Tense Terminology

Slide 19

Paragraphs Mini Essays Topic Sentences Top or Bottom Break When Ideas Change Never Repeat Ideas, Words, or Sentences 3+ Sentences

Slide 20

ELEVATE TO ACADEMIC TONE and LANGUAGE Final: Conclusive studies remain elusive. First Draft: We just don’t know much.

Slide 21

Upgrade. Based on the fact that -> because For the purpose of -> for As previously discussed -> OMIT (<3pgs) As stated … As stated -> OMIT REPEATED WORDS and Phrases

Slide 22

The difference between the right word and the almost right word is like the difference between light and the lightening bug. -Mark Twain Thesaurus.com

Slide 23

Be specific Manageable levels Adequate lighting Proper procedures Correct timing

Slide 24

Appearance Matters NEVER FORGET THE AESTHETICS OF THE PAGE

Slide 25

Good Design is as easy as … Contrast Difference can be good. Repetition Repetition unifies. Alignment Be clean and clear. Proximity Connect visually/logically.

Slide 26

KISS Precise Visual = Precise Text Describe Visuals in Nearby Text Need to Know Basis

Slide 27

Our system for developing launch the main rocket controls (shown in Figure 1) is based on four main parts that operate through a digital electromechanical interface at the site. Figure 1. Four part system for rocket launching controls ALWAYS TAG VISUALS

Slide 28

Acknowledge the Work of Others You must cite all information other than common knowledge which you discover in another source and must quote all language you use that derives in part or whole from another source. As Smith says, “It’s hopeless" (32). As some have said, “It’s hopeless" (Smith 32). I too wanted to say, “It’s hopeless" when I read this (Smith 32). This includes paraphrases and ALL quotes even if you have given the author's name in the sentence or paragraph above. KNOW AND USE THE CITATION GUIDE FOR YOUR FIELD.

Slide 29

Commas Quick and Dirty INTRODUCE QUOTES Smith says , CREATE CONTEXT After reading this, Last week,

Slide 30

Add Nonessential Details Subject + Predicate = Sentence Amy Wept. Present participle phrase, Subject, adjective clause, Predicate, adverbial phrase, prepositional phrase. Watching the news, Amy, who was known for her hair, wept, as if her heart were breaking, in the kitchen

Slide 31

Subject + Predicate = Sentence Always do a S+P check on complex sentences. Set off details with commas. Choose which details relate or are necessary. Cut details for clarity or … Start a new sentence!

Slide 32

Commas Detangle Complex Writing Wallace Smith Associates (WSA) is a major worldwide transportation planning and infrastructure design consultant that offers a wide array of planning engineering and construction phase services yet maintains a local presence that provides clients a quicker response time personal relationships and familiarity with project areas especially in the areas of intersection and reconstruction projects all while maintaining a world class reputation for skill and knowledge unmatched in the design construction and engineering industries.

Slide 33

Possible Rewrite Wallace Smith Associates (WSA) is a major worldwide transportation, planning, and infrastructure design consultant that offers a wide array of planning, engineering, and construction phase services, yet maintains a local presence that provides clients a quicker response time, personal relationships, and familiarity with project areas, especially in the areas of intersection and reconstruction projects, all while maintaining a world class reputation for skill, and knowledge unmatched in the design, construction, and engineering industries.

Slide 34

Advanced Punctuation Style Em dash- emphatic afterthoughts = ! This is long- and time consuming. Colon: Lists, but only after a complete sentence. My boss needs: Semicolon; connect two interconnected complete thoughts Call me tomorrow; I will have an answer then. Bullets and Lists Not Reader Friendly

Slide 35

The best editor asks, “so what?”.

Slide 36

TRANSITION BE STILL SPEAKING PLAN Presenting Visuals

Slide 37

Presenting Visuals

Slide 38

How Do I Get Better Take Grammar Tests www.chompchomp.com Read Professional Models Write Professionally and Get Feedback

Slide 39

Need More Help? Visit: The eStudio 108A RGAN

URL:
More by this User
Most Viewed