Technical Writing PDF

TECHNICAL WRITING Grammar: Technical/Essay: Necessary for both - Focuses on providing an explanation, Organization direction, or instruction. Technical: I-B-C, Topic sentenc...

TECHNICAL WRITING Grammar: Technical/Essay: Necessary for both - Focuses on providing an explanation, Organization direction, or instruction. Technical: I-B-C, Topic sentences, length is - Writing style has specific dependent on type characteristics and purposes - Less complex and straightforward Essay: Introduction, Thesis statement, Body, language Topic Sentence, Transitional Words - Factual data from relevant, reliable Style sources (easy to comprehend) Technical: Short denotative words Ex: Policy Manuals, User Manuals, Essay: Uses longer connotative words, longer Reports of analysis, Instructions for sentences and pararagphs assembling a product, Process Manuals, Instruction Manual, Document Design Summaries Technical: Uses bullets, spaces, headings, subheadings, graphics, fonts TECHNICAL VS. EXPOSITORY (Both are Essay: Rarely uses bullets, spaces, headings, explanatory & descriptive) graphics, fonts Technical TECHNICAL VS. LITERARY - Relies on gathered data Technical - Providing data and presenting them impersonally - Impersonal, formal voice/tone - Straightforward, brief and concise - Adheres to conventional formats and Expository standards in presentation of empirical information - Creative, expressive, opinionated - Limited to science and technology - Provides proof to promote an - Non-fictional, intended for specific argument to be true audiences TECHNICAL VS. ESSAY Literary Development - Personal or informal Technical/Essay: Uses research, anecdotes, - Verbose and prosaic data testimony, and examples - Less restrictive - Any subject can be presented in the language and style of the author 3types: - Human expressions are creatively Document Accuracy- writer presented shall cover everything that readers need to know (proper documentation) FIVE COMPONENTS OF TECHNICAL Stylistic Accuracy- writer does WRITING not just use generic words but the exact ones (word choice) Technical Accuracy- writer’s 1. Development mastery and prowess to - Do not require lengthy paragraphs shape and analyze data with idioms and connotative words without distortion of facts 2. Grammar (simplification) - Correctness of statements that can 2. Clarity result in either correct or faulty - Vague technical writing can be message interpretations extremely dangerous 3. Organization - Use simple and easy to recognize - Uses shorter paragraphs (3-4 vocabulary and less complex sentences) that are easy to organize sentences. 4. Style - Terminologies, abbreviations, and - Simple and direct terminologies, figures need to be consistent to avoid denotative words, short sentence confusion structures, short paragraphs, and 3. Conciseness nonpoetic thoughts are required. - On-point language is encouraged - Letters, memos, and instructional - Avoid phrases in writing that do not brochures do not need words for have specific meanings pleasure. Cliches- Overused expressions and 5. Document Design should be avoided because they can be - Follow strict design and formatting, misinterpreted. These can be sayings, requires layouts that are often based general statements, or idiomatic on the institution’s choice and expressions. preference Ex: Play your cards right TRAITS OF TECHNICAL WRITING Better late than never 1. Accuracy - Truthfulness and trustworthiness of Read between the lines the writer in presenting bias-free All for one, One for all facts  And they lived happily ever after Timebound: entire task, stimulate ideas 2. Structure Time flies (Layout, logo, document design) 3. Write the Data (Plain English, concise, The time of my life clear, audience recognition, WH Only time will tell detail, Lead, Active voice) 4. Review (Polishing Stage, spot error, At the speed of light proofread, revise 4. Accessibility 5. Publish (disseminate) - Enhancing Accessibility (Green, 2020) Headings (virtually break ideas) Text size (11 font size) Alignment (left to maintain neatness) Spacing (2.0 body spacing is not advised) Tables (not colorful) Images (Viewable, colorful images) Colors (combine dark and light colors) 5. Audience Recognition - Determine levels of audience to decide whether to use abbreviations, jargon, or acronyms. - Use inoffensive language that respects the audience’s race, gender, religion, ethnicity, age, class, and sexual orientation - World is multiculturally composed. Know the basic greetings and salutations. MORGAN’S 5 STAGES OF TECHNICAL WRITING 1. Planning/Pre-Writing Stage: Brainstorming, gather, outline, ideas Consider: Scope