Advanced Advanced Technical Technical WritingWriting

20082008

Session #2

Web Space?Web Space?You have access to an account You have access to an account provided by MSU– your provided by MSU– your AFS SpaceAFS Space..

http://www.msu.edu/~your_msunet_idhttp://www.msu.edu/~your_msunet_id

To put stuff there, FTP to To put stuff there, FTP to ftp.msu.eduftp.msu.edu and store files in the and store files in the directory called directory called public_html; public_html; Or, Or, in a networked lab, map the drive in a networked lab, map the drive and navigate to your public_html and navigate to your public_html directorydirectory

Did that last bit of jargon confuse you?

Project 1: Ergonomics Project 1: Ergonomics PosterPoster

For the first project, we’ll be building a For the first project, we’ll be building a poster that helps folks working in poster that helps folks working in Bessey 317 to work in egonomically Bessey 317 to work in egonomically appropriate ways. appropriate ways.

Individually, your job will be to develop Individually, your job will be to develop content for the poster & play an content for the poster & play an editorial role in its production. You editorial role in its production. You should also document your participation should also document your participation carefully.carefully.

Project 1, ContinuedProject 1, Continued

Information will come from…

But we will…

OSHA online site + MSU Ergonomic Info Center

Customize the information for the specific users and specific ergonomic challenges of EBH 317

We will also Test the poster with real users to be sure that it is a useful and usable resource

Project 1, ContinuedProject 1, Continued

We will consider four key topics, each of which will be We will consider four key topics, each of which will be assigned to an editorial team:assigned to an editorial team:

Workstations (chairs, tables, computers)Workstations (chairs, tables, computers) Non-Workstation areas (tables, laptops)Non-Workstation areas (tables, laptops) Lighting & displays (monitors, projector, overhead lights, Lighting & displays (monitors, projector, overhead lights,

resolutions)resolutions) Work Processes (timing, group dynamics)Work Processes (timing, group dynamics)

We will negotiate issues of design, sequence, real estate, etc. We will negotiate issues of design, sequence, real estate, etc. for each of these areas on the poster.for each of these areas on the poster.

Project 1, continuedProject 1, continued

In addition to reviewing key TC concepts & In addition to reviewing key TC concepts & skills, we’ll learn other valuable skills, we’ll learn other valuable things:things:

► We’ll explore the complexities of We’ll explore the complexities of managing multiple content-providers, managing multiple content-providers, including managing format & content including managing format & content consistencyconsistency

► You’ll learn important content You’ll learn important content management conceptsmanagement concepts

……and there might be a few twists thrown in and there might be a few twists thrown in along the way…along the way…

Project 1, RequirementsProject 1, Requirements

► A poster, suitable for hanging up in A poster, suitable for hanging up in 317, is our final deliverable; you 317, is our final deliverable; you will produce all the digital assets will produce all the digital assets needed for the final production of the needed for the final production of the posterposter

► A portfolio, compiled by each person, A portfolio, compiled by each person, of work contributed to the poster of work contributed to the poster projectproject

► Your portfolio will be a section of Your portfolio will be a section of your project page that makes your your project page that makes your contributions to the project visiblecontributions to the project visible

Project 1, TimelineProject 1, Timeline► 1/10 Choose editorial team, review information 1/10 Choose editorial team, review information in your topic areain your topic area

► 1/15 Teams propose poster concepts1/15 Teams propose poster concepts► 1/17 Teams work out semantic markup scheme for 1/17 Teams work out semantic markup scheme for poster content; individuals create content poster content; individuals create content assetsassets

► 1/22 Teams create wireframes of posters; 1/22 Teams create wireframes of posters; individuals plug assets into wireframesindividuals plug assets into wireframes

► 1/24 Teams create poster draft for testing1/24 Teams create poster draft for testing► 1/31 Teams make adjustments to semantic 1/31 Teams make adjustments to semantic structure; Individuals revise digital assets for structure; Individuals revise digital assets for poster poster

► 2/2 Poster ready to ship to post-production shop2/2 Poster ready to ship to post-production shop

Review: writing Review: writing proceduresprocedures

► Parts: Title, Title Image, Byline, Parts: Title, Title Image, Byline, Introduction, Alerts, Warnings, Advance Introduction, Alerts, Warnings, Advance Organizers, Steps, Process Images, Outcome Organizers, Steps, Process Images, Outcome Images, TroubleshootingImages, Troubleshooting

► Writing Steps:Writing Steps: Number the stepsNumber the steps Do the steps as you write themDo the steps as you write them Begin each step with a verbBegin each step with a verb Use positive commands whenever you canUse positive commands whenever you can Include one action per stepInclude one action per step Group steps together in meaningful waysGroup steps together in meaningful ways Use visual cues to keep steps distinct and cue Use visual cues to keep steps distinct and cue sequencesequence

Clarify steps with visual information Clarify steps with visual information

Dobrin, Keller, & Weisser

Technical Communication in the Twenty-First Century

Seeing a document as a Seeing a document as a collection of objects…collection of objects…

Markup…Markup…

All of these tags, attributes, rules, All of these tags, attributes, rules, selectors, declarations…what do they selectors, declarations…what do they mean for information designers?mean for information designers?

They are all tools you use well ONLY if They are all tools you use well ONLY if you can start to see a document as a you can start to see a document as a collection of objects…so, let’s collection of objects…so, let’s practice.practice.

Workshop Time!Workshop Time!

Workshop Time!Workshop Time!Take a look at the OSHA source material. Take a look at the OSHA source material.

Break it up into the Break it up into the objectsobjects that would be defined in that would be defined in a Cascading Style Sheet…a Cascading Style Sheet…

Now…break it up into objects (chunks of text and or Now…break it up into objects (chunks of text and or images with semantic lables) that you think are images with semantic lables) that you think are useful for the poster…useful for the poster…

Grad students…represent the whole semantic Grad students…represent the whole semantic structure of one of the subgenresstructure of one of the subgenres

Objects for CSS

subsection title

List item in body text

…and what else?

Defining objects for CSS is largely a question of asking what elements on the page will need special display rules

Objects for Poster

Subsection theme lead image

Defining objects for the poster is largely a question of asking what semantic elements on the page can be reused? (not a question of display…yet)

Quick Tip

Objects for Poster

Subsection theme lead image

Defining objects for the poster is largely a question of asking what semantic elements on the page can be reused? (not a question of display…yet)

Quick Tip

Semantic Structure

Making the semantic structure explicit involves locating all the relevant content objects, showing how they are related to one another, and noting their attributes (e.g. required or optional?)

Title

Overview

Key Terms

Advance Organizer Section

Next Time…Next Time…

►Editorial teams present poster Editorial teams present poster conceptsconcepts

►Read Applen, Crowley, Geisler Read Applen, Crowley, Geisler et. al., & Carliner (this will et. al., & Carliner (this will take you a while)take you a while)