Technical Writing for Teams: The STREAM Tools Handbook / Edition 1 available in Paperback
A unique, integrative, team-centered approach to writing andformatting technical documents
- Do you have difficulty producing high-quality documents withmultiple contributors when faced with a tight deadline?
- Do you need a process that enables global team members tocollaborate online as they produce sophisticated documents?
- Do you prefer the ease of a WYSIWG desktop publishing tool likeMicrosoft Word rather than more complex software like LaTeX?
- Professors and Graduate Students:
- Do you want to streamline the process of writingmulti-investigator papers, reports, proposals, and books?
- Do you spend a lot of time formatting documents instead ofthinking and writing?
- Do you write research papers in Microsoft Word and then need toconvert them to LaTeX for your thesis?
- Do you write research papers in LaTeX and then need to convertthem to Microsoft Word when embarking on collaborations with yourcolleagues from industry?
- Do you need to write a research paper and don't know where tostart?
- Do you need to collaborate with classmates on a long paper andfind yourself lost in organizational details rather than immersedin the content?
If you answered "yes" to any of these questions, TechnicalWriting for Teams: The STREAM Tools Handbook is for you. Itprovides an easy-to-learn system that streamlines individual andcollaborative writing, allowing you and your teams to instantlybecome more productive and create the highest quality documents ina minimum amount of time. Introduced here are the STREAMTools—Scientific and Technical wRiting,Editing, And file Management Tools—whichunlock your collaborators' potential and addresses team dynamics,separation of duties, and workflow. You'll see how to ensurecompatibility among multiple writers, achieve consistentformatting, organize content, integrate bibliographic databases,automate the process of document preparation, and move contentbetween Microsoft Word and LaTeX. Checklists, guidelines, andsuccess stories are also included to help you operate asefficiently as possible.
From planning and editing documents to solving common teamwriting problems to managing workflow, Technical Writing forTeams: The STREAM Tools Handbook is the one-stop reference thatallows teams to collaborate successfully and create unified,effective documents.
|Product dimensions:||6.20(w) x 9.30(h) x 0.62(d)|
About the Author
ALEXANDER V. MAMISHEV is an Associate Professor in theDepartment of Electrical Engineering at the University ofWashington, as well as the Director of the Sensors, Energy, andAutomation Laboratory and the Director of Industrial AssessmentCenter.
SEAN D. WILLIAMS is Associate Dean of the Graduate Schooland Associate Professor of Professional Communication at ClemsonUniversity. He is the cofounder of the Carolinas Virtual WorldsConsortium, and conducts research on collaborative writing, virtualteams, and technical communication.
Table of Contents
CHAPTER 1. INTRODUCTION.
1.1 IN THIS CHAPTER.
1.2 OUR AUDIENCE.
1.2.1 A few horror stories.
1.2.2 Some history.
1.3 THE NEED FOR A GOOD "WRITING SYSTEM".
1.4 INTRODUCING STREAM TOOLS.
1.4.1 What is STREAM Tools?
1.4.2 Why use STREAM Tools?
1.4.3 The software of STREAM Tools.
184.108.40.206 Recommended packages.
220.127.116.11 A brief comparison of Microsoft Word vs. LaTeX: historyand myths.
1.5 HOW TO USE THIS BOOK.
CHAPTER 2. QUICK START GUIDE FOR STREAM TOOLS.
2.1 IN THIS CHAPTER.
2.2 A GENERAL OVERVIEW OF THE WRITING PROCESS.
2.3 INTRODUCTION TO WRITING QUALITY TOOLS: THE STREAM TOOLSEDITORIAL MARK-UP TABLE.
2.4 INTRODUCTION TO DOCUMENT DESIGN TOOLS.
2.4.1 Important fundamental concepts.
18.104.22.168 Step 1: Use template files to create your newmanuscripts.
22.214.171.124 Step 2: Copy existing elements and paste them into a newlocation.
126.96.36.199 Step 3: Edit the element.
188.8.131.52 Step 4: Cross-referencing elements.
2.4.2 Creating Elements in a Document.
184.108.40.206 References (literature citations).
2.5 INTRODUCTION TO FILE MANAGEMENT: OPTIMIZING YOURWORKFLOW.
2.5.1 General principles.
2.5.2 Using a wiki for file management.
2.5.3 Version control.
CHAPTER 3. DOCUMENT DESIGN.
3.1 IN THIS CHAPTER.
3.2 CREATING TEMPLATES.
220.127.116.11 How to create and cross-reference a headingtemplate.
18.104.22.168 How to alter a heading template.
22.214.171.124 Common formatting mistakes in headings.
126.96.36.199 Common stylistic mistakes for headings.
188.8.131.52 Tips and tricks.
184.108.40.206 How to create and cross-reference an equationtemplate.
220.127.116.11 How to alter an equation template.
18.104.22.168 Common formatting mistakes for equations.
22.214.171.124 Common stylistic mistakes for equations.
126.96.36.199 Tips and tricks.
188.8.131.52 How to create and cross-reference a figure template.
184.108.40.206 How to alter a figure template.
220.127.116.11 Common formatting mistakes in figures.
18.104.22.168 Common stylistic mistakes in figures.
22.214.171.124 Tips and tricks for figures.
126.96.36.199 How to create and cross-reference a table template.
188.8.131.52 How to alter a table template.
184.108.40.206 Common typesetting mistakes.
220.127.116.11 Common stylistic mistakes in tables.
18.104.22.168 Tips and tricks for tables.
3.2.5 Front matter.
22.214.171.124 Controlling page numbers.
126.96.36.199 Table of contents.
3.2.6 Back matter.
3.3 USING MULTIPLE TEMPLATES.
3.3.1 Controlling styles.
3.3.2 Switching between single-column and double-columnformats.
3.3.3 Master documents.
3.4 PRACTICE PROBLEMS.
3.5 ADDITIONAL RESOURCES.
CHAPTER 4. USING BIBLIOGRAPHIC DATABASES.
4.1 IN THIS CHAPTER.
4.2 WHY USE A BIBLIOGRAPHIC DATABASE?
4.3 CHOICE OF SOFTWARE.
4.4 USING ENDNOTE.
4.4.1 Setting up the interface.
4.4.2 Adding references.
4.4.3 Citing references.
4.5 SHARING A DATABASE.
4.5.1 Numbering the database entries.
4.5.2 Compatibility with BiBTeX.
4.6 FORMATTING REFERENCES.
CHAPTER 5. PLANNING, DRAFTING, AND EDITING DOCUMENTS.
5.1 IN THIS CHAPTER.
5.2 DEFINITION STAGE.
5.2.1 Select your team members.
5.2.2 Hold a kick-off meeting.
5.2.3 Analyze the audience.
5.2.4 Formulate the purpose.
5.2.5 Select the optimum combination of STREAM Tools.
5.3 PREPARATION STAGE.
5.3.1 Evaluate historical documents.
188.8.131.52 Journal articles.
184.108.40.206 Theses and dissertations.
5.3.2 Populate the file repository.
5.3.3 Create a comprehensive outline of the document.
220.127.116.11 Using deductive structures.
18.104.22.168 Using Microsoft Word’s Outline feature.
5.3.4 Populate all sections with "yellow text".
5.3.5 Distribute writing tasks among team members.
22.214.171.124 Choose a drafting strategy.
126.96.36.199 Synchronize writing styles.
5.4 WRITING STAGE.
5.4.1 Enter content.
188.8.131.52 Legacy content.
184.108.40.206 New content.
220.127.116.11 Control versions of shared files.
5.4.2 Request that team members submit their drafts.
5.4.3 Verify that each section is headed in the rightdirection.
5.4.4 Construct the whole document.
5.4.5 Revise for content and distribute additional writingtasks.
18.104.22.168 Comprehensive editing.
22.214.171.124 STREAM Tools Editorial Mark-up table (STEM Table).
126.96.36.199 Strategies for editing electronic copy using MicrosoftWordan overview of Microsoft Word’s commenting, reviewing,and proofing features.
5.4.6 Distribute additional writing tasks.
5.5 COMPLETION STAGE.
5.5.1 Copy edit the document.
5.5.2 Send out for a final review of content and clarity.
5.5.3 Proofread the document.
5.5.4 Submit the document.
5.5.5 Conduct the final process-improvement review session.
5.7 ADDITIONAL RESOURCES.
CHAPTER 6. BUILDING HIGH QUALITY WRITING TEAMS.
6.1 IN THIS CHAPTER.
6.2 UNDERSTANDING THE BENEFITS AND CHALLENGES OF TEAMWORK.
6.2.1 The payoff of teamwork.
6.2.2 Some principle challenges of teamwork.
6.3 IDENTIFYING TEAM GOALS AND ASSIGNING MEMBER ROLES.
6.3.1 Define roles and procedures clearly.
188.8.131.52 Define team roles.
184.108.40.206 Define team procedures.
6.4 MANAGING TEAMWORK AT A DISTANCE.
6.4.1 Building trust in virtual teams.
6.4.2 Demonstrating sensitivity to cultural differences.
6.5 SELECTING COMMUNICATION TOOLS TO SUPPORT TEAMWORK.
220.127.116.11 Creating a wiki.
18.104.22.168 Monitoring edits.
22.214.171.124 Other suggestions for wiki use.
126.96.36.199 Web pages.
188.8.131.52 Alerts and site management.
6.7 ADDITIONAL RESOURCES.
CHAPTER 7. ASSURING QUALITY WRITING.
7.1 IN THIS CHAPTER.
7.2 CHOOSING THE BEST WORDS 278.
7.2.1 Choose strong words.
184.108.40.206 Use strong nouns and verbs.
220.127.116.11 Choose words with the right level of formality.
7.2.2 Avoid weak words.
18.104.22.168 Check for confusing or frequently misused words.
22.214.171.124 Avoid double negatives, and change negatives toaffirmatives.
126.96.36.199 Avoid changing verbs to nouns.
188.8.131.52 Delete meaningless words and modifiers.
184.108.40.206 Steer clear of jargon.
220.127.116.11 Avoid sexist or discriminatory language.
7.3 WRITING STRONG SENTENCES.
7.3.1 Write economically.
7.3.2 Include a variety of sentence types.
7.4 AVOIDING WEAK SENTENCE CONSTRUCTION.
18.104.22.168 Comma splices.
22.214.171.124 Fused or run-on sentences.
126.96.36.199 Misplaced, dangling, or two-way modifiers.
188.8.131.52 Faulty parallelism.
7.5 PUNCTUATING FOR CLARITY.
7.5.1 End punctuation.
184.108.40.206 Question marks.
220.127.116.11 Exclamation points.
7.5.6 Dashes and hyphens.
7.6 FINAL CONSIDERATIONS.
7.6.1 Abbreviations and acronyms.
7.6.5 Fractions and percentages.
7.6.6 Units of measure.
7.7 A FINAL NOTE ON GRAMMAR.
7.8 ADDITIONAL RESOURCES.
CHAPTER 8. CONCLUDING REMARKS.
8.1 IN THIS CHAPTER.
8.2 BUSINESS CASE.
8.3 FREQUENTLY ASKED QUESTIONS.
8.4 SUCCESS STORIES.
8.5 ADDITIONAL READING.
8.5.1 Useful books and articles.
8.5.2 Useful weblinks.