Course overview
Goals and objectives
Computing requirements
How do I communicate?
How will I learn?
How will I be graded?
How do I start?
Course outline

Introductory information

Working with a structured editor
Getting started - the basics
Installing the software
Authoring documents
Saving files
Locating files
Publishing files
Conducting a search in the course

Resumes

Personal data
Job objectives, career goals, career objectives
Summary of qualifications or skills summary
Education
Work experience
Additional sections
References
Additional tips

Letters

Thinking critically about letter documents
Letter writing tips
Heading
Introductory paragraph (body)
Middle paragraphs (body)
Concluding paragraph (body)
Footer
Cover vs. broadcast letters

Introduction to XML

XML and technical writing
What is XML?

Introducing XML
The origins of XML
The motivation for XML
XML objectives
The advantages of XML
The limitations of XML

What can you do with XML?

E-commerce and XML
E-publishing and XML
Single source documentation

XML document components

XML declaration
Document type declaration
Document type definition
Intermingled markup and text

The XML language

Markup
Structure
Elements
Attributes
Well-formed and valid documents

Working with XML documents

Authoring
Display and print

Quiz
Summary

Editor tutorial

Introduction
XML editor interface
Editing using Text, Enhanced Grid and Authentic view

Text view
Enhanced Grid view
Authentic view

Organizing files using Projects

Opening a project
Exploring the OLL Project
Opening sample files in the OLL Project

Elements

Element entry helper
Adding elements

Attributes

Attribute entry helper
Adding attributes

Validating files
Transforming XML to HTML
Saving files

Letter DTD tutorial

Overall structure of a letter
Sample letter
Starting a new document using a template
Starting a new document without a template
Adding an XML file to the project
Required and optional elements
LETTER elements
Heading elements
Adding a salutation and subject
Paragraphs
Bold and italics
Web links
Lists
Closing elements
Publishing the letter to HTML

Resume DTD tutorial

Overall structure of the resume
Starting a new resume
RESUME element
PERSDATA element
OBJECTV element
SKILLS element
WORKEXP element
EDUCATN element
SECTION element
INTRESTS element
REFS element

Assignment one

Description
Requirements
Creating the letter and resume
Publishing the XML files to HTML
Submitting the assignment

Audience

Introduction
The audience question
What is an audience?

Types of audiences

Write for your audience

Meet your audience's needs
Set standards in style, form, graphics, and design
Be careful about assumptions

Audience analysis

Analyzing multi-faceted audiences
Analyze your audience
Identify the characteristics of the audience
Assess the objectives and needs of the audience
Create an audience profile

Manual

Principles of technical writing

Technical writing is interpreting
Planning is crucial
Technical writing is not creative writing
No one wants to read your manual
Not just manuals

Creating a manual
Preparing a documentation plan

Completing an audience analysis
Brainstorming and mind mapping
Completing a task analysis
Completing an audience-task matrix
Completing an outline of your manual
List your assumptions
Setting standards (layout and writing)

Understanding information types

Reference information
Procedural information
Instructional information
Conceptual information
Combining information types
Manual structure

Using the elements of technical writing

Playscripts
Tables
Diagrams
Lists

Writing tips, tricks and advice

The Six Cs
Passive vs. active
Write in the active voice
Phrasal verbs
Use positive rather than negative phrases
Follow the Joy of Six
Be consistent
Write in small chunks
Use descriptive headings
Use graphics
Use plain language
Use consistent format for instructions
Maintain a clear structure
Provide an overview for main sections
Write for one
Write clearly
Use parallel form in lists
Manual checklist

Editing

Substantive edit
Copyedit
Proofreading
Peer review

Ensuring retrievability

Table of contents
Glossary
Index
How to index

Testing for usability
Further reading

Graphics

Introduction
Graphics in technical documents
Choosing your graphic
Captions
Types of graphics

Graphs
Tables
Diagrams and illustrations
Photographs
Icons

Sources of graphics

Screen capture
Scanning pictures

Graphics in online documents

Web design and graphics
Size of graphics
Image formats
Saving graphics from Web pages
Backgrounds
Image alignment
Making graphics with irregular shapes
Horizontal rules and bullet icons
Graphic software

Graphic checklist
Further reading

Using the Helpmanual DTD

Overall structure of the helpmanual DTD
Creating a new XML file
Working in Authentic view
Helpmanual element
Front element
Applying an HTML transformation
Transforming XML to PDF
Topic element
Topic-based content
Numbering of topics
Nesting topics
Automatic links to nested topics
Body element

Paragraphs
Viewing element information in XMLSpy
Notes and cautions
Lists
Figures
Tables
Sections
Drop-down links

Bold and italics
Links
Comments
Inline graphics
Index

Related links
Back elements

Glossary
Bibliography

Assignment two

Form a group
Description
Preparation
Requirements
Manual proposal
Submitting the assignment

Manual revisited

Manual development process
Usability testing defined

Mental models

A do-it-yourself usability kit

Abstract
Setting up the test
Considerations: will usability testing help?
References

A usability test case

Setting up a usability test
Performing a usability test

Online help systems

A taxonomy of devices
Information types
Writing help systems
General observations

Further reading

Document design

Introduction

Essentials of design

Determining format

Using grids for page composition
Text organizers
White space
Using color
Integrating text and graphic devices

Electronic document design

Content is king
Page identity
Backgrounds
Links
Designing for browsers
Site structure and navigation
FAQs
Sample page layouts

Developing good design
Further reading

Standards

Introduction

Standards as an editing tool

Setting standards

Selecting authorities
Setting your tone
Organizing your material
Setting your layout
Spelling
Word usage
Punctuation
Miscellaneous

Editing
Sample standards

Sample writing standards
Sample layout standards

Further reading

Assignment three

Description
Preparation
Requirements
Grading
Submitting the assignment

Reporting

Introduction
Purpose of report writing
What is reporting?
Elements of reporting

Narrative
Context
Audience
Content and evidence
Style
Form and structure

The reporting spectrum

Graphical representation
Scientific report
News article
Academic report
Announcement
Speech/Address
Magazine article
Story
Reporting in different styles

Formatting your information

Preliminary pages
Summary
Main section
Conclusion
Recommendations
References
Glossary (optional)
Appendix (optional)

Form

Developing good form
Typography and form

Typographical terminology
Type size
Emphasis
Choosing the right typeface
Monospaced or proportional fonts
Typography on the web

Assignment four

Description
Requirements
Writing your report
Grading
Submitting the assignment

Writing guide

Paragraphs

Paragraph length
Topic sentence
Paragraph unity and coherence
Consistency of tense and pronoun

Sentences
Sentence problems

Run-on sentences
Sentence fragments
Dangling and misplaced modifiers
Lack of parallel structure
Lack of sentence variation
Wordiness
Agreement
Unclear pronoun reference

Matters of style

Non-sexist language
Jargon and technical terminology
Passive and active voice

Punctuation

Comma
Semicolon
Colon
Period
Question mark
Hyphen
Dash
Punctuation quiz

Revision tactics

Revision checklist

Glossary

Resources

Quick reference sources
Electronic journals
Scholarly societies
XML resources
Writing resources