Specifications …writing descriptive detail. Specifications: Purpose Document a product in enough detail that someone else could create or maintain it.

Slides:



Advertisements
Similar presentations
PowerPoint Tutorial 1 Creating a Presentation
Advertisements

Create Your Own Instruction Manual. Objectives Create an instruction manual, step-by-step guide to perform a task or project. Create an instruction manual,
descriptions, and instructions?
English & Communications for College
Word 2007 ® Business and Personal Communication How can Word 2007 help you create and manage lengthy documents?
Word 2007 ® Business and Personal Communication How can Word 2007 help you create and manage lengthy documents?
Preparing Business Reports
Creating a Poster It is easier than you think! 1.
1.Go to the START MENU Tab. 2.Click ALL PROGRAMS. 3.Select TexTHELP PROGRAMS. 4.Click on READ and WRITE 6. 1.The TextHelp log-in will appear. 2.Leave it.
Lesson 2 — Working with Text
Graphics Graphics will help you achieve: conciseness – large amounts of information in a small space clarity – clarify complex information Trends in line.
Document Design Customized & Workplace Training AAI/Portland Community College Facilitated by George Knox.
Procedural Writing Writing a How-To Paper.
McGraw-Hill Technology Education © 2004 by the McGraw-Hill Companies, Inc. All rights reserved. Office Word 2003 Lab 3 Creating Reports and Tables.
© 2005 Prentice Hall4-1 Stumpf and Teague Object-Oriented Systems Analysis and Design with UML.
Pasewark & Pasewark 1 Word Lesson 6 Working with Graphics Microsoft Office 2007: Introductory.
Business Memo purpose of writer needs of reader Memos solve problems
Abstract # 0000 Make the Main Title with Large Bold Type Your Name Here Your Department Here Texas A&M Health Science Center Make the Main Title with Large.
Microsoft Office 2007: Introductory 1 Word Lesson 6 Working with Graphics Computer Applications 1.
© M. Reber 9/6/2015 Instructions Writing Step-By-Step Procedures.
Functional Descriptions
MECHANICS OF WRITING C.RAGHAVA RAO.
FIRST COURSE Creating a Presentation. XP Objectives Open and view an existing PowerPoint presentation Switch views and navigate a presentation View a.
Accelerated 10 English 1. Read 2. Details 3. Topic – Significant to the Text 4. Return to the details. o Details are combined/interpreted to determine.
Assassination Research Paper Creating a Works Cited Page.
Chapter 2 Creating a Research Paper with References and Sources
Chapter 18: Technical Definitions Group C English 3359 Mr. Marohang Limbu May 14, 2010.
Drafting and Revising Definitions and Descriptions
Creating a PowerPoint Presentation
© M. Reber 10/6/2015 Functional Descriptions Documenting Product Specifications.
Getting the Language Right ITSW 1410 Presentation Media Software Instructor: Glenda H. Easter.
The Non-Designer’s Design Book Design and Typographic Principles for the Visual Novice By Robin Williams.
Examining the parts of a subject... From Reading to Writing Manners and proper social behavior are concerns to people in any age—from the Victorians.
Chapter 14. Writing Definitions, Descriptions, and Instructions © 2013 by Bedford/St. Martin's1 What are definitions, descriptions, and instructions? A.
CREATING A POWERPOINT PRESENTATION. Planning a presentation Create a presentation Rearrange and delete text and slides Add animations Add transitions.
Word 2007 ® Business and Personal Communication How can Word 2007 help you create and manage lengthy documents?
McGraw-Hill Career Education © 2008 by the McGraw-Hill Companies, Inc. All rights reserved. Office Word 2007 Lab 2 Revising and Refining a Document.
FORMAL REPORTS. 2 8 PARTS of FORMAL REPORTS 3 V. 8 PARTS 1. Cover/Title Page 2. Letter or Memo of Transmittal 3. Table of Contents 4. List of Illustrations.
Objectives Set the margins of a document. Align text.
Page Design and Elements
Chapter 4 Working with Frames. Align and distribute objects on a page Stack and layer objects Work with graphics frames Work with text frames Chapter.
Practical Programming COMP153-08S Week 5 Lecture 1: Screen Design Subroutines and Functions.
Technical Communication A Practical Approach Chapter 17: Style in Technical Writing William Sanborn Pfeiffer Kaye Adkins.
GUI development with Matlab: GUI Front Panel Components GUI development with Matlab: Other GUI Components 1 Other GUI components In this section, we will.
Technical Communication A Practical Approach Chapter 7: Definitions and Descriptions William Sanborn Pfeiffer Kaye Adkins.
Page Design and Elements TECO 63 M. Reber Page Design Helps readers understand information Indicates hierarchy of ideas and concepts Helps readers.
FIRST COURSE PowerPoint Tutorial 1 Creating a Presentation.
Chapter 3 Memos.
© 2011 Delmar, Cengage Learning Chapter 4 Working with Frames.
Windows layout. During the design process, the individual elements, or building blocks, of screens will have been identified. A logical flow of information.
McGraw-HillCopyright © 2011 by The McGraw-Hill Companies, Inc. All rights reserved. Office Word 2010 Lab 1 Creating and Editing a Document.
TABLE OF CONTENTS 2014 BasmahAlQadheeb. What is a report? A report is a clearly structured document that presents information as clearly as possible.
THE OTHER 12A RHETORICAL MODES DEFINITION, NARRATION & DESCRIPTION, ANDCOMPARE/CONTRAST.
©2014 The McGraw-Hill Companies, Inc. All rights reserved Designing Documents, Slides, and Screens Module Five Copyright © 2014 by The McGraw-Hill Companies,
MS WORD INFORMATION TECHNOLOGY MANAGEMENT SERVICE Training & Research Division.
Academic Writing Fatima AlShaikh. A duty that you are assigned to perform or a task that is assigned or undertaken. For example: Research papers (most.
Understanding definitions, descriptions, and instructions
Page Design and Elements
Analytical Essay Proper Punctuation.
Document Development Cycle
Creating Links – Lesson 3
Microsoft Word 2003 Illustrated Complete
Template for IBI poster 56 inches in width and 36 inches in height The title occupies no more than two lines First Author1, Second Author2, Third Author1,2.
Word Lesson 6 Working with Graphics
Applications Software
Template for IBI poster 36 inches in width and 48 inches in height The title occupies no more than three lines First Author1, Second Author2, Third Author1,2.
Writing an Engineering Report (Formal Reports)
Template for IBI poster 48 inches in width and 36 inches in height The title occupies no more than two lines First Author1, Second Author2, Third Author1,2.
Interface Design Interface Design
PowerPoint Tutorial 1 Creating a Presentation
Presentation transcript:

Specifications …writing descriptive detail

Specifications: Purpose Document a product in enough detail that someone else could create or maintain it. Note: “Specifications” is always plural.

Specifications: Audience The person who is going to build or maintain it The user is not the audience There is no “you” in Specifications Tone = formal

Specifications: Scope Require exhaustive detail –Means you leave nothing unspecified –Everything that is implicit is made explicit –Nothing is left to the imagination – nothing is assumed Need to provide both textual descriptions and illustrations –Illustrations supplement descriptions – do not replace them Usually adhere to a hierarchical outline format –Mirrors the organization of most programs: hierarchical –Use menu “trees” that break down into commands or trees of their own Are usually lengthy documents

Keys to Writing Specifications Translate acuity to effective, accurate descriptions –Expand with details, examples, comparisons, analogies –Use illustrations –Label items you refer to (use callouts in illustrations) Use a hierarchical approach Focus on what it is, not what it is not Avoid circular definitions Find that the devil is in the details

Explanatory Methods Extended definition –Need more than one phrase or sentence to explain –Explore a number of qualities –Usually give example to help reader Definition by analogy –Helps to show similarities with familiar Definition by cause –Explain cause Definition by components –Break concept into its component parts Definition by exploration of origin Negative definition –Effective only when the reader is familiar with what is being contrasted

Specifications: Organization 1.Introduction Where you include the overall purpose 2.Requirements Where you identify what is required to build it (e.g., materials) 3.Description Where you describe it (not what it does) Include all specific details (e.g., measurements, color, shape) 4.Functionality Where you describe the function of each part mentioned in 3 Refer to your callouts and figures in your text Note: Parts 3 and 4 have the exact same hierarchy.

Two Common Outlining Schemes Numbering Scheme I. A. 1. a. 1) i) b. 2. B. II. A. 1. Decimal Numbering Scheme

Things to remember… Alignment –Review Williams on the “Definite Line” rule. Because this paper is using outlines and hierarchies, be sure that every indentation means something hierarchically. (See outline scheme.) Proximity –Be sure to provide more space between separate sections than you allow between lines within those sections. Systemic Progression –Carefully consider the order that you will cover the appearance. Remember that English people view top to bottom, left to right. Description, not Functionality –Remember not to stray into the functionality when you’re describing the product. Save that for the functionality section.

More things to remember… Hierarchy –Be sure your document adheres to a consistent system of hierarchy. –Do not go down in your hierarchy for descriptions, only for sub-parts. Overview –Remember to provide an overview statement. –Paragraph form, not outline format Setup –Cut excess repetitive words or phrases by mentioning commonality in a set-up statement in the overview. –Reserve the itemized description for the distinguishing characteristics. POV –Remember not to address the user as “you.”

Even more things to remember… Parallelism –Be sure all lists are parallel, whether each item begins with an infinitive verb (to do something), an imperative verb (do something!), a gerund (doing something), a noun (something), or any other form. Graphics –Label all graphics. –Graphics do not replace text descriptions; they enhance them. Everything –Do not omit descriptions on the basis of “common knowledge.” Specifications specify everything.

Even more details to remember… Headings –Never follow a heading with a pronoun that assumes a reference to that heading. A heading is a title, not part of the text that follows it. E.g., if your heading was “Rod,” you would not follow it with … This is a …. Do not itemize or list qualities, like a dictionary definition –You would not say: 1. Flight icon; (a) it is square; (b) it contains and image of a bird; (c): the bird is blue. –You would say: 1. Flight icon: a square containing an image of a blue bird.

Even more things to remember… Numbers –Write out numbers lower than ten. See Harris for other rules. Order of modifiers –When stringing a long list of modifiers in front of a noun, English requires they be in a specific order: number size shape age color NOUN Ten 5/8 th -inch long, cylindrical blue screws Note: the comma in that list of modifiers…

Even more things to remember… Apply the proper rules for hyphenating modifiers –Hyphenate measurements as a compound adjective when it occurs before a noun. An eight-inch rod –Do not hyphenate when it is the object of a preposition following a noun The rod of eight inches in length –Do not hyphenate if the measurement occurs in the predicate The rod is eight inches long Use present tense

Be Descriptive Revise/rewrite for correctness and descriptiveness. 1.There is a 5-inch rod by 8-inches extending from the handle. 2.The Title bar is a blue stripe that is at the top of the window and that is the width of the screen. 3.The New Document is a white rectangle with a small downward pointing triangle that is where the corner usually is. 4.There is a list of tasks that will be presented in the Task Box. 5.There is a change in the color of this indicator button when there is a message that is incoming.