Processes and Guidelines Writing Process: from Audience to Rough Draft: 1.Finding a Topic 2.Analyzing audience and purpose 3.Narrowing down your topic.

Slides:



Advertisements
Similar presentations
Reading and writing reports
Advertisements

Technical Communication 1
Writing a Research Paper Getting Started
How to use online databases for research purposes? UIC library.
PARRT THREE: Processes and Guidelines in Technical Writing.
Chapter 12 – Strategies for Effective Written Reports
Revising Drafts© Dr. Ayman Abdel-Hamid, CS5014, Fall CS5014 Research Methods in CS Dr. Ayman Abdel-Hamid Computer Science Department Virginia Tech.
Document Design Customized & Workplace Training AAI/Portland Community College Facilitated by George Knox.
Geography 1000B Essay Requirements Topic Physical geography-related topic of your choice Proposal due: February 10 (value – 5%) Essay due: March 24 (value.
What is User Centered Design? Create “usable” user interface Reduce need for teaching, help, and manuals Uncover and address unmet needs Follow a process.
Proofreading, Editing & Revising Customized & Workplace Training AAI/Portland Community College Facilitated by George Knox.
Managing Team Projects. Chapter Goals  Be able to explain why team skills are important to the modern workplace.  Know the structure of a workplace.
© Prentice Hall, 2005 Excellence in Business CommunicationChapter Writing Business Reports and Proposals.
185 Final Project (Also covers Project Proposal and Document Specification)
Writing Reports Ian McCrum Material from
Three Phases of Effective Writing
ORGANIZATION. I. Organizational Guidelines 3 GUIDELINES (1) DIFFERENT SECTIONS = DIFFERENT READERS o Organize for ALL readers o READER ANALYSIS: Readers’
Introduction Chapter 10 :: Drafting and Revising Coherent Documents Pages 218 to 236 By: Meghna Nagarajan, Sarah Curet, Brandon Plunkett, Andrew Hardin,
Business Communication Workshop
Research Papers Outlines. Why write an outline? Organizes ideas Puts info in a logical form Defines boundaries Shows relationships with material.
Exploring a topic in depth... From Reading to Writing The drama Antigone was written and performed 2,500 years ago in a society that was very different.
Research Papers Outlines. Why write an outline? Organizes ideas Puts info in a logical form Defines boundaries Shows relationships with material.
Planning and Writing Your Documents Chapter 6. Start of the Project Start the project by knowing the software you will write about, but you should try.
Call to Write, Third edition Chapter Sixteen, The Writing Process: A Case Study of a Writing Assignment.
1 Technical & Business Writing (ENG-315) Muhammad Bilal Bashir UIIT, Rawalpindi.
HU113: Technical Report Writing Prof. Dr. Abdelsamie Moet Fall 2012/13 Pharos University in Alexandria Faculty of Engineering Lecture 5: Preparation.
STEPS TO SUCCESSFUL WRITING!. The writing process consists of strategies that will help you proceed from idea or purpose to the final statement.
Selecting a Topic and Purpose
CHAPTER 15, READING AND WRITING SOCIAL RESEARCH. Chapter Outline  Reading Social Research  Using the Internet Wisely  Writing Social Research  The.
Getting the Language Right ITSW 1410 Presentation Media Software Instructor: Glenda H. Easter.
Copyright © 2010 Pearson Education InternationalChapter Writing Reports and Proposals.
What Is Science? Why Write Research Paper? Research paper is written report that enables you to look for similar studies or work done on the question you.
1 Developing a Departmental Style Guide by Jean Hollis Weber Presented by Elliot Jones.
Dobrin / Keller / Weisser : Technical Communication in the Twenty-First Century. © 2008 Pearson Education. Upper Saddle River, NJ, All Rights Reserved.
LECTURE FOURTEEN SUMMARY WRITING. Definition and characteristics Steps in writing a summary How to write a summary Writing Practice.
PREPARING REPORTS CoB Center for Professional Communication.
Chapter 10Management Communication 2e Bell / Smith Slide 1 of 4 Purposes of the Short Report Inform (what is known?) Analyze (why have circumstances developed?)
REPORT WRITING WHAT IS A REPORT?  A report is a very formal document that is written for a variety of purposes in the sciences, social sciences, engineering.
Writing RESEARCH REPORTS MRS. A. KIM. Understanding the Research Report The Research Process Choosing your subject Doing preliminary research Limiting.
1 Technical & Business Writing (ENG-315) Muhammad Bilal Bashir UIIT, Rawalpindi.
The Reflective Log Writing Shahid Hussain. What is a Reflective Log? Analysis of the work you have completed Analysis of the work you have completed What.
Copyright © 2010 Pearson Education, Inc. publishing as Prentice HallChapter Writing Reports and Proposals.
Chapter Two Composing. The Writing Process Analyzing the writing situation: identify the reason and purpose for writing, the situation in which the document.
Training Computer Users Writing For End Users. What is Training? Focus on performing activities building expertise that will be immediately useful.

Call to Write, Third edition Chapter Two, Reading for Academic Purposes: Analyzing the Rhetorical Situation.
William Sanborn Pfeiffer Kaye Adkins
©2011 Cengage Learning. All Rights Reserved. May not be scanned, copied or duplicated, or posted to a publicly accessible website, in whole or in part.
Overview of the Research Process These outlines of the research process were created using the book Schaum’s Quick Guide to Writing Great Research Papers.
Structure and Cohesion. Organisation of a piece of academic writing Types of academic writing – reports, essays, projects, assignments, reviews etc. Structure.
Processes and Guidelines in Technical Writing Part (2)
Research Paper Guide Twelve Step Guide to Writing A Research Paper By Ramona L. Hyman, PhD Copy© 2013by Dr. Ramona L. Hyman.
1 Technical & Business Writing (ENG-715) Muhammad Bilal Bashir UIIT, Rawalpindi.
Chapter 9. Writing Coherent Documents © 2010 by Bedford/St. Martin's1 Consider these eight questions as you revise the document for coherence: Have you.
Dobrin / Weisser / Keller: Technical Communication in the Twenty-First Century. © 2010 Pearson Education. Upper Saddle River, NJ, All Rights Reserved.
11 Proposals and Formal Reports. Introduction Proposals o Informal o Formal Research Writing Formal Reports Elements of Formal Reports.
Report writing skills A Trade union training on research methodology, TMLC, Kisumu, Kenya 6-10 December 2010 Presentation by Mohammed Mwamadzingo,
BCOM 7 Organizing and Preparing Reports and Proposals 11 Copyright ©2016 Cengage Learning. All Rights Reserved. May not be scanned, copied or duplicated,
Academic writing.
End User Support – User Training
Writing Effective Abstracts
Advanced Technical writing
Hints and Tips for Writing Formal/Technical Documents
Chapter 18 Formal Reports
COM 170 Innovative Education--snaptutorial.com
ENG 147 Innovative Education- -snaptutorial.com
Printed Indexes and Abstracts
Writing reports Wrea Mohammed
Comment on Students’ Stories, And A Guide to Literary Criticism
Presentation transcript:

Processes and Guidelines Writing Process: from Audience to Rough Draft: 1.Finding a Topic 2.Analyzing audience and purpose 3.Narrowing down your topic 4.Outlining your report 5.Arranging the parts of the outline 6.Writing a rough draft and comparing it to the outline 7.Revising the rough draft.

Task Analysis The job of the technical writer is to create information for products that help users use products. The goal is not simply to describe how the product works. When you write instructions, procedures, and "guide" or user-guide information, you normally must use a task approach. That means providing steps and explanations for all the major tasks that users may need to perform.

Strategies for Peer-Reviewing and Team-Writing Strategies for Peer-Reviewing Initial meeting Peer-reviewing strategies Peer-review summary Strategies for Team-Writing Assembling the team Planning the project Scheduling the project Balancing workload Setting up a style guide or style sheet Reviewing drafts and finishing

Different Approaches to Documentation 1.Writing with a function orientation: It explains each function, feature, or interface element of a product. If this approach shows up in user guides. It is meant for nontechnical readers — perhaps because the writers are inexperienced, untrained, or technical.

2. Writing with a task orientation: 1.Identify the tasks users will need to perform with the product. 2.structure your document accordingly. 3.Make your headings and subheadings task oriented in their phrasing. like "How to adjust the volume, "Adjusting the volume," or "Adjust the volume." It does not mean phrasing like "Volume" or "Volume Adjustment."

Stronger transitions and overviews: Repetition of key words Arrangement of key words Transition words and phrases Reviews of topics covered and topics to be covered

Power Revision Techniques How you organize your writing, and how you link it all up together. This means: Looking for potential problems and then fixing those problems There are: structure-level revisions Sentence-level revisions

structure-level revisions Checking contents Checking organization Strengthening topic sentences Strengthening transitions Checking paragraph length and contents

Sentence-level revisions Revising weak be-verbs Revising noun stacks Revising redundant phrasing Revising weak expletives Revising weak passive-voice sentences Revising subject-verb mismatches Revising sentence-length problems

Libraries, Documentation, Cross Reference Libraries Library Requirement Descriptors and Keywords Finding Information Sources Internet Resources Books Magazine and Journal Articles Reference books--handbooks, guides, atlases, dictionaries, yearbooks

Documentation Document your citations Make your work legal Use: The number system (Scientific documentation)

Cross References Point readers to other places in the same document or to other information sources where related information can be found. A cross-reference consists of: Name of the source being referenced Page number Subject matter of the cross-reference

Types of cross-reference Internal cross-reference: Refers to some other part of the same document. External cross-reference: Refers to information outside of the current document