advanced technical writing 2006 session #13. today in class ► the third analytic perspective:...

23
Advanced Advanced Technical Technical Writing Writing 2006 2006 Session #13

Upload: gladys-dawson

Post on 06-Jan-2018

221 views

Category:

Documents


1 download

DESCRIPTION

Today’s focus… Genre and features A Focus onSees the site as Emphasizes the point of view of Structure & Delivery Production Models & Workflows a text; or a collection of texts the reader/user objects & actions; social space a workplace the designers & developers the admins and “authors”

TRANSCRIPT

Page 1: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

Advanced Advanced Technical Technical WritingWriting

20062006

Session #13

Page 2: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

Today In ClassToday In Class►The third analytic perspective: The third analytic perspective:

workflows & production modelsworkflows & production models►Thinking about “metadata”Thinking about “metadata”

Page 3: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

Today’s focus…Today’s focus…

Genre and features

A Focus on Sees the site as

Emphasizes the point of view of

Structure & Delivery

Production Models & Workflows

a text; or a collection of

texts

the reader/user

objects & actions; social

spacea workplace

the designers & developers

the admins and “authors”

Page 4: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

Looking at Websites as Looking at Websites as WorkplacesWorkplaces

Consider the context in which a site is produced; what is the production model the site follows? What are the workflows like which keep this production model going?

Page 5: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

Production Model?Production Model?The overall approach to producing the site. For example, the CNN.com site has a broadcast news production model… in terms of the way content is generated, how often it is updated, the types of media generally available, etc.

Can you think of sites with 2 other types of production models…one, like CNN.com, based on a legacy model and another which you would consider a model “native” to the web?

Page 6: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

What are some features What are some features of a production model?of a production model?

•Who creates the content; why do they do it?

•Who owns or has authority/responsibility for content

•Who consumes/uses content; why?

•What kinds of content are produced (think of information and interaction)

•How often? (related to how dynamic)

•How is content strategy/success measured?

Page 7: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

What are workflows?What are workflows?

The cycles of activity that, added together, make up the day-to-day work of maintaining the site.

For this project, we are only concerned about content-related workflows, which could include the kinds of activities mentioned in the production model: producing content, editing content, evaluating user needs, etc.

Page 8: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

Elements of workflowsElements of workflowsJob roles – who does what?

Tasks – what do they do?

Process descriptions – in what order?

Metrics – how do we know its done or ready to move on?

Page 9: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

Two types of workflows, 1Two types of workflows, 1Managed workflows

What is it? How do I document it?

Processes & routines already documented and/or consciously leveraged in the workplace context

Gather training documents, schedules, etc.; interview mgmt. & production staff; observe

Page 10: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

Two types of workflows, 2Two types of workflows, 2Ad-Hoc workflows

What is it? How do I document it?

Observe the day to day production cycles and do follow-up interviews with mgmt., staff, & maybe users

Processes & routines that may vary and are not consciously leveraged in the workplace context, yet

Page 11: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

Formats for documenting Formats for documenting workflowsworkflows

Managed workflows

Ad-hoc workflows

Linear methods are ok since you know beginning and end points: Calendar-type schedules, Gantt charts; may need flow charts for recursive processesMust usually use multiple methods to show variations as well as patterns; case studies of typical and “critical incident” using the above formats; also PERT (critical path) or event-chain diagrams

Page 12: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

Capture events: a tip Capture events: a tip comes into the comes into the

newsroom…newsroom…

talk

document

E-doc

(ph)one

(st)aff mtg.

(m)emo

1:00 2:00 3:00 4:00 5:00ph st

e

e

e

m ph p

e(mail)

(p)roposal

Page 13: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

An Exercise in An Exercise in documenting workflowsdocumenting workflows

Go to a non-web setting; go to a store, a fast-food place, etc. and pick a short cycle that you are familiar with; map it with a swimlane diagram. (See next slide)

Page 14: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

Sample workflow: news item

karen

audrey

eric

paulette

plan

draft

review

publish

Page 15: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

Metadata, what is it good Metadata, what is it good for?for?

• Searching for content

• Enabling dynamic content

• Enabling systematic reuse

• Enabling customized or on-demand views

• Tracking content use

• Automating content production processes

• Tracking content production

Page 16: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

Metadata influences…Metadata influences…• Searching for content

• Enabling dynamic content

•Enabling customized or on-demand views

•Enabling systematic reuse

• Tracking content use

• Automating content production processes

• Tracking content production

Direct Influence on developers

Direct influenceon users

Page 17: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

Two types of metadataTwo types of metadataCategorization Metadata – Refers to information products (e.g. documents); most often used to create structured data storage and retrieval systems (e.g. libraries)

Element Metadata – Refers to information objects (elements) within information products; used to enhance search and retrieval, track use, facilitate reuse, facilitate/track workflow

Page 18: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

Uses for metadataUses for metadata

Reuse

Retrieval

Tracking

semantic labels keep presentation formats distinct from content

labels based on search logics, including access privileges

labels reflect element status, production milestones, management metrics

Page 19: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

Reuse

Retrieval

Tracking

Metadata Metadata ExampleExample

Page 20: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

Metadata Metadata ExampleExample

Reuse

Retrieval

Tracking

Page 21: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

An Exercise: Create An Exercise: Create metadata for an “ACD metadata for an “ACD

exercise posting”exercise posting”1. Define element metadata categories that could

be applied to ACD exercises posted by students

2. Consider two user groups: students and instructors

3. Consider all three metadata use types: reuse, retrieval, tracking

4. User your colleagues postings for reference

Page 22: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

An Exercise: Create An Exercise: Create metadata for an “ACD metadata for an “ACD

exercise posting”exercise posting”Be prepared to discuss:

► How each audience type might engage in How each audience type might engage in reuse, retrieval, and trackingreuse, retrieval, and tracking

► Issues you encounter in choosing terms Issues you encounter in choosing terms (i.e. controlled vocabulary)(i.e. controlled vocabulary)

► How, when, and who might apply the How, when, and who might apply the metadata? System features that could aid metadata? System features that could aid in this process?in this process?

Page 23: Advanced Technical Writing 2006 Session #13. Today In Class ► The third analytic perspective: workflows & production models ► Thinking about “metadata”

Next Time…Next Time…► We’ll review analytic stances and We’ll review analytic stances and

toolstools► You’ll begin planning your own You’ll begin planning your own

analysis for your P2 contextanalysis for your P2 context► You’ll share the scope of your You’ll share the scope of your

analysis and your plans with the analysis and your plans with the groupgroup