|
China Focus 2006
LISA Workshops in Shanghai
Writing Technical Documentation: A Primer for Non-English Speakers in the Tech-doc WorldLearning to design and write information that is useful to your readers09:00 - 17:00 : Monday, April 17, 2006 Workshop Program
Welcome and Introduction
- Who's who?
- What does each participant hope to take away from this workshop?
Writing Effectively, Part 1
- Principles of good sentence construction
- Understanding sentence grammar
- Case of nouns and pronouns (compound subjects, appositives, compound objects, who/whom)
- Verbs
- Agreement of subject and verb
Writing Effectively, Part 2: Writing Clear Sentences
- Parallel constructions
- Modifiers (including misplaced and dangling ones)
- Constructions to avoid (stacked nouns, sentence fragments, fused sentences, and comma splices)
Writing Effectively, Part 3: Mechanics and Usage Notes
- Abbreviations and Acronyms
- Capitalization
- Punctuation
- Italics
Writing Effectively, Part 4: Making Appropriate Word Choices
- Choosing and Using Words
- Misused/Abused Words
- Spelling (rules, compound words, use of hyphens, unit modifiers
Getting Ready to Write
- Determining audience, scope, and tone
- Organizing material
- Topic sentences
- Writing paragraphs
Understanding Your Audience
- Who are they? Questions to ask (and answer!)
- What are the reader’s requirements?
- Creating an audience profile
Understanding the Documentation Process
- Planning
- Analyzing your audience
- Analyzing the purpose
- Generating ideas and researching
- Organizing and outlining your document
- Determining the required deliverables
- Scheduling
- Preparing a Document Plan
- Drafting the document
- Reviewing and testing
- Making revisions
- Final reviews and revisions
- Producing the document
|
