Conventions of Technical Documents Scott Hale ENGL 3153 Technical Writing.

Slides:



Advertisements
Similar presentations
Typography Typography exists to honor content. — Robert Bringhurst,
Advertisements

Page Design Also called Visual Design; refers to structure and appearance of information on the page Elements: Legible type, Generous margins, Textual.
Poster title goes here, containing strictly only the essential number of words... Author’s Name/s Goes Here, Author’s Name/s Goes Here, Author’s Name/s.
 A functional document is any piece of text or diagram that helps people accomplish a task.  There are three main aspects or parts to all functional.
Format for Ease of Access Importance Design Principles Design Elements.
T Y P E L A Y O U T. Old Design Know the rules before you break the rules. W I S D O M ________________________________________.
DIGITIAL COMMUNICATION SYSTEMS Objective 5.05
Page Design. Overall design issues u Know audience expectations u Know client expectations u Maintain a consistent look and feel u Consider how each page.
Kira Jones Oral Communication Instructor
Document Design Customized & Workplace Training AAI/Portland Community College Facilitated by George Knox.
Document Design: Basics and Typography Technical Communication, DAHMEN.
Chapter 2. STRUCTURE n The arrangement of information (organization) and the techniques used to highlight information (page design)
Designing Pages and Documents Shariah Landry & Steven Joles.
Dobrin / Keller / Weisser : Technical Communication in the Twenty-First Century. © 2008 Pearson Education. Upper Saddle River, NJ, All Rights Reserved.
Technical Communication Document Design 1 Guidelines for Document Design Part 1 Paper Documents.
Document Design: Guidelines for Effective Information Layout Dr. Shelley Thomas ENGL 3100.
DESIGNING DOCUMENTS And page layout. What is document design?  Refers to page layout, that is, where the visuals and information are placed on a page.
Typography Web Design Professor Frank. Characteristics of Type on the Web Magazine/book typography – 1200 dpi Computer screens – 85 ppi (maximum)
DCS Goal 5.01 – 5.05 Review. Sections Covered 5.01 – Font Attributes 5.02 – Editing Tools 5.03 – Business Letters 5.04 – Memo and – Simple.
Page Design / Style Guide Importance Design Principles Design Elements.
PAGE DESIGN PAGE DESIGN Giving Your Work the Best Possible Appearance.
Stephanie Poczos Adopted from: CTUO How to Design Effective PowerPoint Presentation.
Chapter 8 Document Design 2 Page Layout
#AIEC2015 PowerPoint Template and Guidelines Screen ratio: 16:9.
DIGITIAL COMMUNICATION SYSTEMS Objective 5.05
Unit 4 – Multimedia Element: Text
Desktop Publishing Your Guide to Concepts and Terminology.
Chapter 12 Designing the Document. 1. To make a good impression on readers Documents should reflect your own professional standards and those of your.
Designing Effective Documents
Page Design Overall design issues u Know audience expectations u Know client expectations u Maintain a consistent look and feel u Consider how each page.
Creating Brochures and Booklets Chapter 6. Purpose of Brochure Informs, educates, promotes, and sells Establishes and reinforces organization’s identity.
The Internet Writer’s Handbook 2/e Web Page Design Writing for the Web.
Chapter 7. Designing Documents and Web Sites © 2013 by Bedford/St. Martin's1 Document and Web design has five goals: to make a good impression on readers.
the rhetorical situation  audience  purpose  context design principles  arrangement  emphasis  contrast  repetition  alignment  proximity (some)
AMERICAN PSYCHOLOGICAL ASSOCIATION (APA) WRITING AND DOCUMENTATION STYLE.
McGraw-Hill/Irwin © 2009 The McGraw-Hill Companies, All Rights Reserved Copyright © 2010 by The McGraw-Hill Companies, Inc. All rights reserved. McGraw-Hill/Irwin.
24 Tips On How To Produce The Best Advertisement Layout By Paul Curran
Document Design ENG 371 Lukowski. Things to Consider Think about your audience and their expectations – How will they read and use your document? – What.
Page Design and Elements
© 2003 Pearson Education, Inc., publishing as Longman Publishers. 1 Chapter 15 Designing Pages and Documents Technical Communication, 9/e John M. Lannon.
© 2003 Pearson Education, Inc., publishing as Longman Publishers. 1 Chapter 15 Designing Pages and Documents Technical Communication, 9/e John M. Lannon.
FORMAL REPORTS. 2 DEFINITION and EXAMPLES 3 I. DEFINITION Formal Reports  For complex projects  For readers of different technical levels  For an.
© 2011 Pearson Education, Inc., publishing as Longman Publishers. 1 Chapter 13 Designing Pages and Documents Technical Communication, 12 th Edition John.
PAGE DESIGN. I. Guidelines of Page Design 3 I. GUIDELINES DEFINITION: o Refers to the creation of clear, readable, and visually interesting documents.
Page Design and Elements TECO 63 M. Reber Page Design Helps readers understand information Indicates hierarchy of ideas and concepts Helps readers.
Chapter 7 Creating a Newsletter with a Pull-Quote and Graphics
Stylistic Options in Business Writing Compiled by PAPIA BAWA.
Effective PowerPoint Presentation
Brochures.  Brochures are small, usually folded, documents used to inform, educate, or persuade the reader.  They are commonly used to promote organizations,
Business Technology Applications Mrs. Jefcoat Page 307.
Basic PowerPoint Guidelines
What are we interested in? 1. Understand Design 0 2. Digital Image design 3 3. Time-based media Webpage design 2 1.
Basic PowerPoint Guidelines Tips for Creating Great Presentations.
Page Design and Elements
Creating a Poster.
Designing Documents, Slides, and Screens
Chapter 13 Designing Pages and Documents
Chapter 9 Layout and Design
Technical Communication Fundamentals Chapter 3: Visual Design
Designing User-Friendly Documents
DTP Terms & Techniques You will need to understand basic terms and techniques used in DTP, as well as file types used within DTP and their advantages and.
Writing an Engineering Report (Formal Reports)
Good document design saves time and money, reduces legal problems, and builds goodwill. A well-designed document looks inviting, friendly, and easy to.
Designing Pages and Documents
Formatting It is a BIG Deal!!!.
Good document design saves time and money, reduces legal problems, and builds goodwill. A well-designed document looks inviting, friendly, and easy to.
Title of presentation | Presentation by [Enter details in 'Header & Footer' field 18/05/2019.
Writing Technical Reports
TECHNICAL REPORTS WRITING
Presentation transcript:

Conventions of Technical Documents Scott Hale ENGL 3153 Technical Writing

Technical Documents n Designed differently than other kinds of documents –Doesn’t use unbroken sequences of words, sentences and paragraphs –Instead uses charts, diagrams, lists, varying fonts/sizes, headings, and other aides to assist document navigation

Technical Documents Con’t... n Rarely receive audiences undivided attention –Readers skim to discern relevant information –Audience should be able to leave a portion of the document and return to it quickly

Technical Documents Con’t... n Audience doesn’t read document as leisurely activity –They read it because they have to –Will use the easiest method

Technical Documents Con’t... n With the rapid proliferation of documents –Your document will compete for your audience’s attention

As a Technical Writer... n Your goal is to make information access and retrieval as easy as possible n Create a USABLE and SCANNABLE document

Creating a Usable Document Design n Shape each page –Consider look, feel, and the overall layout

Paper and Ink n Routine Documents –Black ink on 8 1/2”x11” low-gloss, rag- bond, white paper n Published Documents –Dependant on cost and audience, you may want coated, glossy, heavier paper

Type or Print Quality n Print from laser or ink-jet printer n If ink-jet, use special coated paper

Page Numbers n Use lower-case roman numerals(I, ii, iv, xxv) for title page, table of contents, prefaces, and abstracts n Use arabic numerals (1, 2, 15, 38) for all subsequent pages

Headers and Footers n Signal a change in information or importance n Usually offset with a larger, bolder font/size

White Space n The space on a page NOT filled by text/images n Divides the document into small, digestable groups of related information n Separates sections, headings, tables, and images from text/paragraphs n Intended to improve document appearance, clarity, and emphasis

Margins n Justified –Even right margin creates channels of white space and can be more difficult to read n Used for formal documents: books, annual reports, etc. n Unjustified –Uneven right margins can be easier to read n Used for less formal documents: memos, letters, in-house reports, etc.

Line Length n Too long lines tire your eyes, annoy reader n Too short lines disrupt rhythm of reading, annoy reader n Ideal is sixty to seventy (60-70) characters per line –Nine-twelve (9-12) words per line

Columns n Two-columns often used for newsletters and brochures n Single-columns work best for complex/specialized information

Line Spacing n For documents that will be read in their entirety (memos, letters, etc.), use single-spacing in paragraphs and double-spacing between them, with no indentation n For longer, selectively read documents (reports, proposals, etc.), increase line spacing within and between paragraphs, providing indentation

Tailor Made Paragraphs n Use long paragraphs for clustering closely- related material n Use short paragraphs for making complex material more digestable, giving step-by-step instructions, or emphasizing vital information n Don’t indent, but separate short paragraphs with spacing n Avoid ‘Orphan’ lines of paragraphs

Stacked Lists n Readers prefer lists to paragraphs n List the following –Advice or examples –Conclusions and recommendations –Criteria for evaluation –Errors to avoid –Materials/equipment for procedures –Parts of a mechanism –Steps in a sequence

Stacked Lists Con’t… n Usually requires no punctuation, unless a list of sentences or questions n Set off with a visual aid –Numbers for order of importance –Bullets, dashes, or asterisks for non-order of importance –Open boxes for checklists n Introduce list with an explanation

Fonts n Have/create “personality” For technical documents, use a conservative font, unlike this For technical documents, use a conservative font, unlike this Serifs vs. Non-serifs Serifs vs. Non-serifs n Size is important... n Bold, underline, normal, italic, SMALLL CAPS n CAPITALS vs. lower-case n Big to small, Dark to light

Highlighting n Used for emphasis n Fonts size/style, white space, etc. n Horizontal (un/broken) lines to separate sections or offset warnings n Not all highlighting is equal…

Highlighting Con’t… n Boldface for single sentence/brief statement n Italics for words, phrases, but not multiple lines n SMALL CAPS for headings and short phrases n Small type sizes for captions and labels n Large type sizes used sparingly

Headings n Used for document access and orientation n Informative n Specific, yet comprehensive n Grammatically consistent n Visually consistent n Four levels of heading: Title, Main, Secondary, Tertiary