© M. Reber 10/6/2015 Functional Descriptions Documenting Product Specifications.

Slides:



Advertisements
Similar presentations
Create Your Own Instruction Manual. Objectives Create an instruction manual, step-by-step guide to perform a task or project. Create an instruction manual,
Advertisements

Critical Reading Strategies: Overview of Research Process
Definitions and Classification: Background Reports
Writing an action research report
Original PowerPoint from Muhlenberg County, Kentucky
1 Technical Descriptions Purpose Parts Rewriting.
M. Reber © 5/1/2015 Document Development Cycle Creating Your User’s Guide Step-by-Step.
CE En 112 Engineering Drawing with CAD Application
Preparing for and Taking Tests
STUDYING COLLEGE TEXTBOOKS AND INTERPRETING VIAUAL AND GRAPHIC AIDS
12/28/08 - Mechanism DescriptionCopyright Joanne DeGroat, ECE, OSU1 Mechanism Descriptions.
285 Final Project. Document Specification: Rough Draft Due April 10th Purpose: Purpose: Economy of effort Economy of effort Input from instructors and.
Essays IACT 918 July 2004 Gene Awyzio SITACS University of Wollongong.
Technical Writing II Acknowledgement: –This lecture notes are based on many on-line documents. –I would like to thank these authors who make the documents.
185 Final Project (Also covers Project Proposal and Document Specification)
Module 5 Writing the Results and Discussion (Chapter 3 and 4)
185 Final Project (Also covers Project Proposal and Document Specification)
7 Explaining a Process: Cultures &Traditions. 2 2 Learning Outcomes Identify real world applications for explaining a process in writing. Understand the.
CANKAYA UNIVERSITY FOREIGN LANGUAGES UNIT
Writing Reader-Focused Definitions and Descriptions
© M. Reber 9/6/2015 Instructions Writing Step-By-Step Procedures.
Functional Descriptions
Literature Review and Parts of Proposal
Business Communication Workshop
TECHNICAL WRITING October 31 st, With a partner Write simple “step-by-step” instructions for sending a Kakao Talk message with a phone.
Drafting and Revising Definitions and Descriptions
Organizing Your Information
Copyright © 2002 by Pearson Education, Inc., publishing as Longman Publishers. All rights reserved. Chapter 15 Procedures, Processes, and Specifications.
Descriptive Essays Writing. What is a descriptive essay? It is a written assignment intended to describe the subject matter to the readers so that they.
Chapter 14. Writing Definitions, Descriptions, and Instructions © 2013 by Bedford/St. Martin's1 What are definitions, descriptions, and instructions? A.
PREPARING REPORTS CoB Center for Professional Communication.
Drawings ACT Objective Realize the organization and intent of construction drawings 2.
Effective Communication for Colleges, 10 th ed., by Brantley & Miller, 2005© Chapter 11 Chapter 11 – Slide 1 Reports, Proposals, and Instructions for the.
Writing a Research Proposal 1.Label Notes: Research Proposal 2.Copy Notes In Your Notebooks 3.Come to class prepared to discuss and ask questions.
Section 2 Scientific Methods Chapter 1 Bellringer Complete these two tasks: 1. Describe an advertisement that cites research results. 2. Answer this question:
Chapter 13. Writing Recommendation Reports © 2013 by Bedford/St. Martin's1 Recommendation reports address four kinds of questions: What should we do about.
Thesis Statement-Examples
William Sanborn Pfeiffer Kaye Adkins
Chapter 7. Organizing Your Information © 2010 by Bedford/St. Martin's1 Understand three principles for organizing technical information: Analyze your audience.
Technical Communication A Practical Approach Chapter 7: Definitions and Descriptions 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.
Specifications …writing descriptive detail. Specifications: Purpose Document a product in enough detail that someone else could create or maintain it.
Definition Essay WIT Comp 2. Definition A definition essay is an essay that defines a word, term, or concept. In this essay you should not define a term.
 Reading Quiz  Peer Critiques  Evaluating Peer Critiques.
Technical Description Project Project 2. Overview Write a technical description of a process related to e-waste streams for a lay audience – Work solo.
Introductions and Conclusions CSCI102 - Systems ITCS905 - Systems MCS Systems.
Livingston High School
Copyright © 2012 Pearson Education, Inc.. Chapter 6 Technical Descriptions, Specifications & Definitions Copyright © 2012 Pearson Education, Inc.
Technical Descriptions Considering Audience & the Rhetorical Situation Copyright 2011 © by Pearson Education, Inc.
Sample paper in APA style Sample paper in APA style.
Instruction Set ENGL 202C. CONTENTS Depending on the nature of your task, you may wish to include some or all of the following contents. Introduction.
Study Skills Presenting your work Moodle. Stages to complete an assignment 1. Understand the assignment brief 2. Find the information needed 3. Evaluate.
Definition of a Memo A memo is a short for “memorandum” (Latin: “something to remember”). A memo is a document used for communication within a company.
Instructions Teco-61 M. Reber 01_04. What are instructions? A form of writing that tells/teaches readers how to do something: create a product perform.
Understanding definitions, descriptions, and instructions
Recommendation reports address four kinds of questions:
Recommendation reports address four kinds of questions:
Working Drawings Competency: 00X.00
Document Development Cycle
Document Development Cycle
MECHANICAL DRAWING WORKING DRAWINGS
Introduction to New Product Development (Portfolio)
Writing for Academic Journals
Giving instructions on how to do something
Chapter 9: Drafting and Revising Definitions and Descriptions
TECHNICAL DESCRIPTION
Essay #1: Your Goals as a Writer
Common Core Standard 9-10.RL.Key Ideas and Details
Biology Writing a Lab Report
Formatting Figures in APA Style
Presentation transcript:

© M. Reber 10/6/2015 Functional Descriptions Documenting Product Specifications

Definition of a Functional Description An overall description of the function and appearance of the entire mechanism A description of the function and appearance of each major part of the mechanism An explanation of how the mechanism operates and how each part contributes to the functioning of the whole Functional Descriptions focus on physical, quantifiable details They are often also called a mechanism description or a product specification 2

What Functional Descriptions are NOT Not typical user instructions or documentation Not comprised of steps or “how to“ instructions 3

Uses of Functional Descriptions To instruct the assembler/repairperson To market a product to prospective buyers To explain a product to an owner 4

Functional Descriptions are Organized: By location (spatially)  If you are describing a car for new owners, you might organize according to location so that your reader will learn about the comforts and conveniences available to them when sitting in the passenger compartment According to function  If you are describing a car for mechanics, you might organize according to function so the reader can effectively diagnose and correct problems 5

Parts of a Functional Description Title Introduction  Names the object  Explains origin of the name  Explains its function or behavior  Describes its overall appearance  Lists its individual parts Sections for the various parts Drawings and other graphics Conclusion  Explains how it works (NOT how to operate it!) 6

Extended Descriptions May Also Include: A scope statement: Indicates what you will and will not specify and who will have which roles and responsibilities A definitions section: Establishes the meaning of any specialized terms (both the scope statement and definitions section can be incorporated into the Introduction if they are short enough A materials section: Specified required materials to be used An operating characteristics section: Lists operational requirements (such as how much load the product can bear) for design and construction purposes 7

To Write a Functional Description: 1.Choose a product requiring description 2.Define the purpose, audience, and situation 3.Research the mechanism as appropriate 4.Identify the parts and subparts 5.Plan the overall description 6.Sketch the headings you’ll use 7.Select the sources of description 8.Plan an introduction 9.Consider the format 10.Review and revise your draft 8

Document All “Sources of Description” Purpose: How is the item used? What are the applications? Size: How big or small is it? Can you compare its size to something familiar? Shape: How is it shaped? Can you compare its shape to something familiar? Color: What are its colors? Texture, finish: How does it feel to the touch? How does it look (shiny, dark, etc.)? Dimensions: What are its length, height, width, depth? 9

“Sources of Description” (cont.) Weight: How much does it weigh? Materials of construction: What materials were used to create it—wood, steel, cardboard? Ingredients: If it is something that is mixed, what are the ingredients? Methods of attachment: How are the different parts attached—glued, welded, bolted, screwed, nailed? Location, orientation of parts: What’s the orientation of the parts to each other—above, below, to the left or right, within? 10

“Sources of Description” (cont.) Age: How old is it? Temperature: Is temperature an important descriptive detail? Moisture content: What’s the percentage of water content? Amounts: How many are there? Capacity: How much can it hold? Volume: What are the various measurements of volume related to it? 11

“Sources of Description” (cont.) Smell, odor: What does it smell like? Pattern, design: Does it have a certain pattern or design associated with it? 12

Tips for Writing Functional Descriptions Be accurate!! (a small discrepancy in measurement might mean an object won’t fit where your reader needs it) Be specific and concrete (give parts a name, etc.) Use simple language and analogies to help readers visualize 13

Questions to Ask Myself 1.What is my purpose? 2.Who is my primary reader and what are his/her needs? 3.How can I learn about the object and its function? (experimentation, literature) 4.What major headings do you plan to use? 5.What should my overview contain?  A definition, a purpose statement, general appearance, illustration, a list of components? 14

Questions to Ask Myself (cont.) 6.How is the breakdown and description of parts organized? Is the organization logical? 7.Have I thoroughly described each part and broken it into components if necessary? 8.What pictures and graphics effectively explain the object? (Cite your sources.) 9.Do I need a conclusion? 15

Your Assignment Choose an object or simple machine you are already familiar with and have at your disposal. For example:  Blender  Air popcorn popper  Blow dryer  Electric razor Write a description of three to five pages (model specific if possible) At a minimum, you should have three parts:  An overview or introduction section  A breakdown into parts with descriptions  Conclusion (explains how the object works) 16

Tips for Completing Your Assignment Understand the purpose and the audience Be model-specific Do not do any outside research!! (graphics excepted) Learn about the object through experimentation Be sure to provide citations for any graphics you did not create 17