Course Syllabus. Technical Writing Certificate - Basic

Transcription

1 Course Syllabus Technical Writing Certificate - Basic Prerequisite(s): 1 year experience using Windows and Microsoft Word. Required Materials/Texts: KSU will provide the following 6 instructional manuals and other handouts as supplied by the instructor. Page Layout and Design Principles, Styles and Formatting, Using Raster Graphics, Organization of Information, Vector Graphics in Documentation, Online and Print Distribution Course Description: This 6-month program covers basic design principles, typography, styles and formats. Use raster or vector graphics, and text wrapping effectively. Use call-outs, labels and legends. Learn to create an online document complete with thumbnails and bookmarks. Master proficiency in Page Plus and FrameMaker to use text flows, variables, cross-references, conditional text and template creation. Generate book-quality documentation, chapter templates, table of contents, indexes, and hyperlinks. Learn how Adobe Acrobat can save space and provide security and portability. Produce portfolio pieces to demonstrate your skills. Students take away 6 books and 2 software programs. Course Length: The Technical Writing Basic Certificate course is scheduled to meet on Saturdays, from 9:00AM to 4:00PM for 11 sessions. Criteria for Successful Completion: Students must attend 80% of the class meetings (9 classes) and actively participate in order to earn CEUs and a certificate of completion. Instructor: Brian Fleming Learning Outcome(s): Design Principles Describe and use the three eyes of designing a page layout. Define the design principles of Contrast/Variety, Harmony/Repetition, Grouping/Separation, and Balance/Alignment and demonstrate their application. Define page balance in terms of symmetrical, asymmetrical, and optical center. Describe the measurement terms and their application in typography. Describe and classify the different kinds of fonts available in desktop publishing, define their characteristics and their strong and weak points.

2 Use Ms Word to create a document using correct page layout and design principles, applying document, paragraph, and character styles. Styles and Formatting Define the three levels of styles and describe how the hierarchy effects their application and use. Demonstrate the creation and editing of document styles and paragraph styles. Demonstrate the different types and correct use of columns in MS Word and Adobe PageMaker in technical documents Describe master pages and their use. Define the print options available in Ms Word and PageMaker and demonstrate the printing of files to produce a double-sided tri-fold brochure. Using Raster Graphics Describe the two major categories of graphics and their characteristics. Demonstrate the reduction of colors in and size of raster Graphics. Demonstrate the correct use of callouts. Describe the different methods of applying legends and labels to raster graphics. Describe the difference between embedding and linking graphics in terms of updating, distributing, and organizing files. Demonstrate the use of raster graphics in documents. Demonstrate the use of screen captures and the use of Paint Shop Pro to capture screen graphics. Define the different types of wrapping as applied graphics. Organization of Information Describe the five major steps to create technical documentation. Describe the Analysis and Planning Step, the Information Collection and Researching Step, the Shaping and Outlining Step, and the Editing and Proofreading Step. Describe methods of organizing information. Demonstrate the creation of effective headings and subheadings using PageMaker. Demonstrate the Drafting step of technical documentation using MS Word and PageMaker. Use standard editing marks in reviewing the draft of a technical document. Demonstrate the proofreading step of technical documentation with an edited document. Using Vector Graphics Define the advantages and disadvantages of line drawings (vector graphics) in technical publications. Create a simple vector drawing (a flow chart) using MS Visio and place it in draft documents. Resize, position and wrap text around vector graphics in MS Word and PageMaker. Use vector graphics both as inline graphics and as part of bullets in MS Word. Demonstrate the ability to edit vector drawings and create callouts and legends. Demonstrate the creation of captions for graphics in MS Word and PageMaker. Print and Online Distribution Define the limitations and advantages of online documents and printed documents. Demonstrate the use of color in headings and other design elements. Setup and configure Adobe s Acrobat Distiller.

3 Use Acrobat Distiller to create an online document from the MS Word and PageMaker versions of the newsletter. Create an online document with thumbnails and bookmarks. Assessment of Learning Outcomes: Demonstrating the skills stated in the objectives, by the end of this course, each student will create Resume Tri-fold Brochure (Print and Online) Newsletter (Print and Online) Methodology: Lecture, class discussion, class assignments, A/V presentation, case studies, reallife experience, classroom exercises. Course outline: Page Layout and Design Principles The Three Eyes Basic Design Principles The Four Design Principles Grouping and Separation Balance and Alignment Harmony and Repetition Contrast and Variety Grouping & Separation Visual Quadrants White Space Using Grouping and Separation Modifying a Business Card Modifying an Advertisement Modifying Lists Modifying a Newspaper Advertisement Guidelines for Grouping and Separations Balance and Alignment Balance Optical Center Symmetrical Balance Asymmetrical Alignment Guidelines for Balance and Alignment Harmony and Repetition Harmony Repetition Guidelines for Harmony and Repetition Contrast and Variety Contrast Guidelines for Contrast and Variety Design Principles Exercises Four Design Principles Summary Type and Typography Types of Type TrueType and PostScript Fonts QuickDraw GX & GX Fonts Unicode National Language Support & WGL4 OpenType Type Categories

4 Type Defined Type Measurements The Em Set Width Kerning Tracking Leading Series Family Classification of Type Classification Types Garalde (Oldstyle) Oldstyle Advantages and Disadvantages Didone (Modern) Mordern Advantages and Disadvantages Lineale (Sans Serif) Sans Serif Advantages and Disadvantages Slab Serif Slab Serif Advantages and Disadvantages Blackletter Blackletter Advantages and Disadvantages Script Script Advantages and Disadvantages Decorative Decorative Advantages and Disadvantages Italic Guidelines for Using Italics Recognizing Font Classes Self-Quiz 1 Contrasting Type Contrast in Size Contrast in Shapes Contrast in Direct Contrast in Weights Contrast in Colors Recognizing Font Contrasts Styles and Formatting The 3 Basic Styles Getting Started Viewing a Formatted Document Creating and Applying Styles in Word Creating and Applying Document Styles Configuring Page Setup Setting Margins Setting Paper Size and Orientation Inserting a Section Break Creating and Applying Paragraph Styles Creating a Style in the Template Attaching a Template Modifying Styles Creating a New Style Manual Formatting In Word Formatting Characters Using the Formatting Toolbar Using the Font Dialog Box Formatting Paragraphs Paragraph Format Options Using the Formatting Toolbar Horizontal Alignment

5 Vertical Alignment Setting Indents Setting Line and Paragraph Spacing Inserting Page and Line Breaks Setting Tabs Creating & Applying PageMaker Styles Creating and Applying Document Styles Setting Up Pages Setting Margins Setting Up Master Pages Applying a Master Page Creating and Applying Paragraph Styles Creating a New Style in PageMaker Editing Paragraph Styles Manual Formatting in PageMaker Formatting Characters The Control Palette Use the Character Specifications Dialog Box to Format Text Formatting Paragraphs Using the Control Palette Horizontal Alignment Setting Indents and Tabs Adding Space Between Paragraphs Columns in Technical Documents Columns In Word Creating Columns in Word Columns In PageMaker Creating Columns in PageMaker Balancing Columns Print Options Printing in Word Preparing Your Document for Print Printing in PageMaker Preparing Your Document for Print Final Project Formatting a Tri-Fold Brochure in Word Creating a Tri-Fold Brochure in PageMaker Raster Graphics Introduction Two Categories of Graphics Raster Graphics Vector Graphics What s the difference? Raster vs Vector Common Graphics Terms Color Reduction Reducing Colors in A Raster Graphic Size Reduction Reducing the Size of a Raster Graphic Reducing the Canvas Size of a Graphic Using Callouts Callouts in Word Creating Callouts in Word Callouts in Paint Shop Pro Creating Callouts in Paint Shop Pro Callouts in PageMaker Creating Callouts in PageMaker Applying Legends and Labels to Raster Graphics

6 Applying Legends to Graphics in Word Adding Headings to a Legend Applying Labels to Graphics in Word Applying Legends to Graphics in PageMaker Adding Headings to a Legend Embedding vs. Linking Embedded Graphics Linked Graphics Embedded vs. Linked Graphics in Word Inserting an Embedded Graphic Inserting a Linked Graphic Embedded vs. Linked Graphics in PageMaker Inserting an Embedded Graphic by Pasting Inserting an Embedded Graphic Inserting a Linked Graphic Placing a Linked Graphic Using Raster Graphics The Importance of Raster Graphics Graphic Comprehension Guideline 1: Make Your Graphics Easy to See Guideline 2: Make Your Graphics Easy to Find Guideline 3: Clearly Label Your Graphics Guideline 4: Make Your Graphics Easy to Understand Guideline 5: Make Your Graphics Appropriate Screen Captures Introduction to Screen Captures Preparing your Screen for Screen Captures Making Screen Captures with the Print Screen Command Using the Print Screen Command Making Screen Captures with Paint Shop Pro Setting Screen Capture Options Capturing a Screen Wrapping Wrapping Options in Word Final Project Adding Graphics to a Newsletter Organization of Information Analysis and Planning Step Planning Guidelines Guideline1: Know Your Readers Needs 3 Reasons for Technical Documents Guideline 2: Include Additional Information Guideline 3: Organize Information Guideline 4: Plan your Graphics Guideline 5: Follow the Policies Information Collection and Researching Step Researching and Information Collection Guidelines Guideline1: Define Your Objectives Guideline 2: Plan your Research Guideline 3: Evaluate Your Findings Guideline 4: Take Notes Research Methods Shaping and Outlining Step Creating Headings in PageMaker General Guidelines for Headings Specific Format and Style Creating First- Level Headings Creating Second-Level Headings Creating Third-Level Headings

7 Designing Your Own Headings Drafting Step Drafting Guidelines Guideline1: Start by Announcing Your Topic Guideline2: Generalizations Before Details Guideline 3: List the Most Important Information First Guideline 4: Reveal your Organization Guideline 5: Consider Cultural Backgrounds Editing and Proofreading Step Proofreading Guideline 1: Evaluate the Objectives Guideline 2: Take Time Away from your Document Guideline 3: Read your Draft Many Times Guideline 4: Use Computer Aids Using the Spell Checker in Word Reviewing Guideline 1: Discuss the Objectives Guideline 2: Build Good Relationships Guideline 3: List Suggestions Editing Guideline 1: Adjust the Effort to the Situation Guideline 2: Edit the Most Important Areas First Guideline 3: Follow the Same Guidelines for Writing Well Copyediting Role of the Copy Editor Role of the Writer Final Project Creating A Newsletter in Word Vector Graphics in Documentation Understanding Graphic Categories Fundamentals of Raster Graphics Fundamentals of Vector Graphics Advantages to Using Raster Graphics Complex Colorization Possible Online Compatibility Animation Easy to Create or Import Disadvantages to Using Raster Graphics File Size Difficult to Edit Do Not Resize Without Distortion Cannot be Converted Into Vector Formats Advantages to Using Vector Graphics Reduced File Size Enhanced Clarity and Reproducibility Ability to Edit Ease of Resizing and Scaling Ability to Convert into Various Formats Disadvantages to Using Vector Graphics Limitation of Colors with Complex Images Lack of Online Compatibility Inability to Animate Creating a Vector Graphic Lines Freeform Lines Straight Lines Arc Lines Node Editing Closing Lines to Make Shapes

8 Exercise 1 Drawing Lines Shapes Stencils Editing Shapes Resizing Shapes Grouping and Aligning Shapes Exercise 2 Modifying Shapes Colors, Fill, Line and Line Ends Editing Colors Line Formatting Patterns Exercise 3 - Colors, Patterns, and Line Formatting Connecting Shapes Text Exercise 4 - Creating an Organizational Chart Importing Vector Graphics Embedded Graphics Linked Graphics Importing Vector Graphics in Word Embedded vs. Linked Graphics into Word Inserting an Embedded Graphic into Word Inserting a Linked Graphic into Word Importing Vector Graphics into PageMaker Inserting a Linked Graphic into PageMaker Editing Linked Drawings in Word and PageMaker Labeling Vector Graphics Considerations for Labeling Graphics Callouts and Legends Creating Callouts in Word Creating Callouts in PageMaker Applying Captions, Legends, and Titles Applying Legends to Graphics in Word Adding Headings to a Legend Applying Captions to Graphics in Word Applying Legends to Graphics in PageMaker Placing the Legend in PageMaker Online and Print Distribution Introduction Online Documents The Advantages of Using Online Documents The Limitations of Using Online Documents The Advantages of Using Printed Documents The Limitations of Using Printed Documents Types of Online Documents Characteristics of Online Documentation Writing for Online Documents Consider Display Issues Using Color Why Use Color? Contrast and Color Configuring Acrobat Distiller Creating a PostScript File for Word Converting PostScript to PDF Creating a PDF File for PageMaker Distiller s Default Job Options Setting the Default Job Options Using Bookmarks Accessing the Bookmarks Panel

9 Bookmark Palette Bookmark Menu Creating a Bookmark Creating Nested Bookmarks When Are Bookmarks Appropriate? Using Thumbnails Accessing the Thumbnails Panel Thumbnail Menu Creating Thumbnails Navigating Thumbnails When Are Thumbnails Appropriate? Final Project Converting your Newsletter to PDF FrameMaker I Before You Begin Pre-Requisites Software You Will Need Installed Curriculum Overview About the Manual Chapter Overviews Learning Your Way Around Open formatted text, save locally FrameMaker at a Glance Interface Toolbars Page Navigation Zoom Controls Menus Creating a New Document Intro to Formatting Formatting at a Glance (local vs. designer) Paragraph Designer Applying Formats Exercise: Use unformatted text to create new styles and formats Advanced Formatting Tabs Numbering/Lettering Next Format setting Character Formatting/Character Designer Overrides and Local Formatting Character Formats in Numbered Lists and Bullets Creating Labels (such as Note:) Basic Editing Text Symbols Smarts Spaces/Smart Quotes Basic Text Editing Changing Page Viewing Spelling Checker Find/Change Command Basic Printing Features Pagination Paper Size Single vs. Double Sided Margins Page Breaks-when to use, how to insert Deleting Empty Pages Keep W/Next, Previous Widow and Orphan Line Control Exercise

10 Document Layouts Text flows Flow tags Column layouts/side Headings (single vs. multi-columns) Text frames Selecting, editing, naming frames Adding disconnected pages Master Pages Default vs custom master pages (R vs. L) Headers and footers Side Headings Mixing portrait and landscape master pages Attaching a master page to a body page Viewing Body and Master Pages Reference Pages (20 minutes) Contents of a reference page Exercise