A Math-Based Writing System for Engineers. Sentence Algebra & Document Algorithms

Description

Preface Developing Math-Based Engineering Writing Sentence Algebra: The Rules and Logic of Grammar How to Use This Book for Teaching and Self Study Acknowledgments Contents Chapter 1: Introduction to the Math-Based Writing System Action Items Recap Part I: Sentence Algebra Chapter 2: Part I Primer: The Elements of Sentence Algebra Eight Functions, Eight Variables ``Spark´´ Five Basic Sentence Equations Advanced Sentence Equations Coding Conventions Some Additional Resources Action Items Recap Reference Chapter 3: The Core Variables N, V, and X N = Noun Features and Properties of Nouns Compound Nouns Number Collective Proper vs. Common Nouns V = Verb Features and Properties of Verbs Verb Tense: The Dimension of Time (When?) Irregular Verbs Verb Number Point of View (POV) or ``Person´´ Verb Conjugation Matrices X = Pronoun Features and Properties of Pronouns POV and Number Gender Case Reconciling Pronouns in Action: Matching Xs with Ns Action Items Recap References Chapter 4: The Accessory Variables: Mn, Mv, L, C, and I Mn = Adjective Four Features of Adjectives in Action Three Special Conventions for Articles Mv = Adverb L = Preposition C = Conjunction Punctuation Conventions for Coordinating and Subordinating Conjunctions Examples of Coordinating and Subordinating Conjunctions in Action Coordinating Conjunctions Subordinating Conjunctions I = Interjection Action Items Recap Chapter 5: Basic Sentence Equations: B1, B2, and B3 Basic Sentence Equation One (B1) Five Applied Demonstrations of B1 Coding Demonstration 5.1 Coding Demonstration 5.2 Coding Demonstration 5.3 Coding Demonstration 5.4 Coding Demonstration 5.5 Basic Sentence Equation Two (B2) Five Applied Demonstrations of B2 Coding Demonstration 5.6 Coding Demonstration 5.7 Coding Demonstration 5.8 Coding Demonstration 5.9 Coding Demonstration 5.10 Basic Sentence Equation Three (B3) Five Applied Demonstrations of B3 Coding Demonstration 5.11 Coding Demonstration 5.12 Coding Demonstration 5.13 Coding Demonstration 5.14 Coding Demonstration 5.15 Action Items Recap Chapter 6: More Basic Sentence Equations: B4 and B5 Basic Sentence Equation Four (B4) Five Applied Demonstrations of B4 Coding Demonstration 6.1 Coding Demonstration 6.2 Coding Demonstration 6.3 Coding Demonstration 6.4 Coding Demonstration 6.5 Basic Sentence Equation Five (B5) Five Applied Demonstrations of B5 Coding Demonstration 6.6 Coding Demonstration 6.7 Coding Demonstration 6.8 Coding Demonstration 6.9 Coding Demonstration 6.10 A Review of Basic Sentence Algebra Coding and Structures Sentence Coding Demo of a Paragraph Scan and Code Sentence Stream Underneath the Text Frequency Action Items Recap Reference Chapter 7: Advanced Sentence Structures: Compound and Complex Sentences and Relative Clauses What Are Advanced Sentences? Compound and Complex Sentence Combinations Compound Sentences Complex Sentences Compound-Complex Sentences Compound and Complex Sentences In-action Bonded Sentences Relative Pronouns (Xrs) and Relative Clauses (RCs) Coding Demonstration 7.6 Coding Demonstration 7.7 Coding Demonstration 7.8 Coding Demonstration 7.9 Coding Demonstration 7.10 Action Items Recap Chapter 8: More Advanced Sentence Structures: Verbal Phrases, Inversions, and Variations Verbals (Vvs) and Verbal Phrases (VPs) Coding Demonstration 8.1 Coding Demonstration 8.2 Coding Demonstration 8.3 Coding Demonstration 8.4 Coding Demonstration 8.5 Inversions and Variations Passive Voice Active Version Passive Version Coding Passive Voice Sentences Questions Original Sentence (Declarative) Six Variations (Interrogative) Coding Interrogative Sentences (Questions) Commands and Requests Expletive Introductions Review Key Concepts and Coding Conventions for Advanced Sentence Equations Coding Demo of a Sentence Stream Containing Basic and Advanced Structures Scan and Code Sentence Stream Underneath the Text Frequency Action Items Recap Reference Part II: Sentence Optimization Chapter 9: Part II Primer: The Elements of Sentence Optimization Twenty Opportunities for Improving Sentences How Grammar Relates to Sentence Optimization Action Items Recap References Chapter 10: Simplify and Clarify Eliminate Deadwood Eliminate Jargon Revise Awkward, Inexact, or Vague Sentences Avoid Faulty Logic Action Items Recap Chapter 11: Eliminate Category I Errors Be on the Lookout for and Eliminate Imposter Sentences Example Imposter Sentences The Scanning Process Do Grammatical Bookkeeping and Reconcile Disagreements Subject-Verb Agreement Errors Pronoun-Antecedent Reference Errors Modifier-Target Location Errors Signal Process Points Within Sentences Using Commas and Other Devices Set Off Introductory Elements Set Off Nested Elements Use Commas to Separate All Items in Lists of Three or More Use a Dash or Colon to Announce Restatements, Amplifications, Expansions, and Lists Punctuating Vertical Lists Distinguish Compound Adjectives from Compound Nouns Using Hyphens Action Items Recap Chapter 12: Advance Optimal Style Strive to Use Active Rather than Passive Voice Left-Side Versus Right-Side Rule Pros and Cons of Active Versus Passive Voice Three Additional Examples Strive to Use Verbs as Verbs and Avoid Noun Clutter Apply Symmetry to Sentence Design Strike a Professional Tone Action Items Recap Chapter 13: Minimize Category II Errors Numbers in Engineering Writing Numbers at the Beginning of Sentences Numbers Within Sentences Combinations of One Digit and More Than One Digit Numbers Leading Zero Equations Basic Mechanics: Capitalization, Bold Font, Italic Font, and Abbreviations Capitalization Bold and Italic Font Using Italics, Bold Font, and Both for Emphasis Using Italics to Denote Titles Abbreviations Selecting Verb Tense Spelling Errors Word Usage Errors Conventional Phrasing Inserting Articles Using Idiomatic Expressions Choosing Prepositions Adding ``s´´ to the End of a Noun to Form a Plural Advice on Building Sentence Optimization Skills to Avoid Unconventional Phrasing Errors Some Additional Resources Action Items Recap References Part III: Document Algorithms Chapter 14: Part III Primer: The Elements of Document Algorithms What Is a Document Algorithm? What Does a Document Algorithm Do and Not Do? Beyond the Five Essential Algorithms and Document Types Action Items Recap Selected Reading Chapter 15: Project Proposals How Does an Engineering Writer Structure a Successful Proposal? How, Specifically, Does an Engineering Writer Apply the Proposal Algorithm? The Framework The Six Key Elements Application Example The Project Scenario Effective Memo Example Ineffective Memo Example Document Geometry: How to Format a Memo Action Items Recap Chapter 16: Status Reports Linear Versus ``Flipped,´´ Bottom-Line-First Structure The Status Report Algorithm Application Example The Project Scenario Writing the Status Report Email Effective Email Example Ineffective Email Example Document Geometry: How to Format an Email Action Items Recap Chapter 17: Project Reports What Is the Algorithm for a Project Report and How Does a Writer Apply It? Application Example The Resultant Project Report Effective Report Example Ineffective Report Example Document Geometry: How to Design and Insert Tables and Figures into Text Universal Best Practices for Inserting Both Tables and Figures Tables Figures (Graphs and Illustrations) Action Items Recap References Chapter 18: Tech-to-Nontech Briefs Using Analogies to Help Nontechnical Audiences Understand Technical Concepts Writing a Tech-to-Nontech Brief Using the Appropriate Document Algorithm Application Example The Project Scenario Effective Brief Example Ineffective Brief Example Document Geometry: How to Format an Informational Brief Action Items Recap Chapter 19: Instructional Job Aids What Is a Skill-Transfer Document? Why Should Engineers Care About Instructions? Instructional Systems Design (ISD) Basics Writing a Short Instructional Document Called a Job Aid Using a Document Algorithm Application Example Effective Job Aid Example Ineffective Job Aid Example Document Geometry: How to Format a Job Aid Instructional Document Action Items Recap References Chapter 20: Expanding and Innovating Short-Form Documents into Long-Form Documents How Structure and Format Change When Short-Form Expands into Long-Form Documents More Detailed Section Descriptions for a Long-Form Generic Engineering Report Front Matter Report Body Back Matter Paragraph Typography Typing a Document´s Title and Headings A Model Long-Form Engineering Report (3 x 3 Evaluation) Action Items Recap References Chapter 21: Twenty Universal Features of Excellent Engineering Documents Document´s Beginning Document´s Middle Document´s End Throughout the Document Action Items Recap Reference Appendix Scan and Code Demo: Using Equations to Identify and Reconcile Imposter Sentences Sentence Algebra Review Index