Make every paper you submit perfect—in content, format, and style.

The STREAM Tools Method

Science, Technology, Research, Education, And Management Tools—or STREAM Tools is a comprehensive methodology aimed to streamline the process of preparing technical proposals and research publications.

It is intended for use by

STREAM Tools makes the process of preparing complex technical manuscripts easy and enjoyable. These techniques are most effective for groups. However, many elements are useful for individual work as well. 

Most technical writing guides are not tied to any particular software practices. 

They follow a sensible philosophy:

“here are your audience analysis paradigms, your composition principles, and your grammar rules, and you can use your favorite software to put your ideas down on paper.” 

STREAM Tools departs from this approach because we specifically recommend that writing teams utilize Microsoft Word.

The STREAM Tools Collection

The STREAM Tools set consists of the following products and services:

The package allows to implement the STREAM Tools methodology below.

The complete STREAM Tools workflow


Read a piece below to learn why we recommend Microsoft Word.

We recommend Microsoft Word primarily for practical reasons: it is simply the easiest to use, is the most widely available, and has enough functionality to meet the needs of nearly every collaborative research team.

Why struggle within your team to decide which software packages to use when others have already done it for you?

Download our Free STREAM Tools Templates for MS Word:

A BRIEF COMPARISON OF MS WORD VS. LATEX: HISTORY AND MYTHS

The choice of a document design system is a huge decision for any organization. In light of the struggle writers face over which software to pick, we offer some commentary in this section on the advantages and disadvantages of both Microsoft Word and LaTeX. Our goal is to demonstrate not just the differences, but also to show why using Microsoft Word will make your writing team more efficient and effective.

Two fundamentally different systems dominate the market for producing research and technical documents: Microsoft Word and LaTeX (or TeX for the most proficient users). "What You See Is What You Get" (WYSIWYG) is the base principle of the MS Word. The writer can immediately see where on each page the text, figures, equations, etc., that he or she adds will appear. One can start using Microsoft Word within seconds as it requires little start-up time.

Most computer users have become familiar with Microsoft Word due to its overwhelming dominance of the general word processing market.

LaTeX, on the other hand, requires entering the text and the references to all graphical elements into a coded text file. Then LaTeX compiles it into a final document. The principles of LaTeX are quite close to those of HTML language. The presentation of content and the content itself are separate. The software handles the pagination, spacing, margins, orphan control, figure placement, and many other small details. The document looks professional even when prepared by a novice. Besides, LaTeX is greatly suited for writing long manuscripts. Even a thousand-page book full of graphics can be compiled with LaTeX using very modest hardware.

The downside is that many people are not familiar with LaTeX. It is difficult for people to learn the software. It is nearly impossible to get everyone to learn LaTeX in collaborative groups where members belong to different organizations, or in large research groups with diverse backgrounds. Besides, the team's time is best spent on research and innovation, not learning software packages. Because LaTeX has a steep learning curve and because many people don't have time to learn yet another software, STREAM Tools employs Microsoft Word as the foundation for collaboration. The methods described in this book rely only on Microsoft Word. You simply cannot get a typical non-technical person started on LaTeX in 30 minutes. In contrast, it is entirely feasible to get an ordinary non-technical person started on STREAM Tools in 30 minutes.

Given this general background, let's examine various issues surrounding the use of Microsoft Word and LaTeX in some detail. First of all, the compatibility between the two systems leaves much to be desired. Although there are software converters which take a Microsoft Word file as an input and then output a LaTeX-compatible file (and vice versa), the formatting of complex documents is not well preserved in the conversion steps. 

Much like a computer translation from a foreign language, extensive human corrections are necessary to guarantee the final result's quality.

A second issue is that different fields use different tools. Since most research teams now span disciplines, deciding on a single authoring tool becomes critical. For example, in business, law, medicine, and most professional communication, Microsoft Word unquestionably dominates. However, LaTeX is the frequent choice in certain fields of hard sciences, like mathematics, physics, or engineering. Professionals in these fields are comfortable with the technical complexity associated with the text file that looks like a computer program. More importantly, scientists and engineers frequently need to manipulate large quantities of equations and graphics.

As long these two groups do not need to collaborate, there is no problem. However, most sophisticated research and innovation now require interdisciplinary teams. For example, a sizeable biomedical instrumentation research project may require input from medical doctors, engineers, statisticians, lawyers, technical writers, and even patients. 

It is not realistic to expect all these participants to give up their expectations of WYSIWYG convenience and instead learn to compile their documents using a rather complex set of rules.

Despite the practical concerns of forcing team members to learn LaTeX, one commonly encounters the opinion in many academic settings that LaTeX solves all typesetting problems; some aficionados will not step away from it under any pressure. 

Some people who hold this position are justified in their view because, indeed, they stand to lose too much by this conversion. 

For example, a tightly knit team composed of a professor and three graduate students who publish only in specialized journals indeed might be better off with LaTeX. However, in most cases, the decision to use multiple, incompatible packages in the same collaborative group is driven by habit rather than an informed choice: the team leaders choose the system based on tradition, personal preference, local user knowledge, or institutional support rather than what will produce the highest quality product most effectively.

Let's examine some of the advantages of each package to debunk a few myths that arise from the differences to demonstrate why some authors might prefer LaTeX, and explain why we encourage using Microsoft Word. 


The advantages of LaTeX over Microsoft Word:

In short, LaTeX does provide some advantages over Microsoft Word, particularly for very long and very complex technical documents. However, Microsoft Word also has advantages.


The advantages of Microsoft Word over LaTeX:

Naturally, experienced writers tend to prefer one package or the other. Often, these opinions are a result of not being adequately informed about software capabilities. The following section examines some common misconceptions.


Myth: Only LaTeX should be used for scientific writing. Microsoft Word does not have the proper tools to manipulate figures, form equations, etc.

Reality: This might be true for highly specialized areas of mathematics. For most engineering and science disciplines, however, Microsoft Word is adequate, as long as it is used effectively.


Myth: LaTeX is suitable for writing long manuscripts, whereas Microsoft Word is good for memos and short papers.

Reality: This used to be true when computers crashed frequently and had slow processors. In the last few years, however, creating manuscripts of several hundred pages, filled with figures and equations, became feasible and easily manageable with Microsoft Word.


Myth: In LaTeX, one can write equations without leaving the keyboard, whereas, in Microsoft Word, one needs to use the mouse all the time.

Reality: This is not entirely true. A handy add-on to Microsoft Word, MathType, provides keyboard shortcuts that allow writing equations with only the keyboard. However, since using the mouse is available, many people never invest their time in learning keyboard shortcuts.

Microsoft Word now has nearly the same capabilities as LaTeX, and we contend that Microsoft Word can now be used in the majority of collaborative writing projects in technical settings.

Most importantly, to get the team to collaborate right away, Microsoft Word requires little training because it is ubiquitous.

Since the primary goal of this book is to provide tips and techniques for those who want to be efficient and effective in their collaborative work, we focus strictly on using Microsoft Word for team collaborations as the core of STREAM Tools.


CUSTOMER REVIEWS

All reviews are here and here.

I think Technical Writing for Teams: The STREAM Tools Handbook would be especially useful as a textbook in classroom settings for students who plan to collaborate on technical writing projects (in academia and the workforce), or as a quick primer for someone who wants to train themselves for this type of work.


EXPERIENCED WRITERS

If you already have experience working in teams, you may want to take a look at it, but probably won't find much new information in here that warrants a purchase. I was hoping to find more innovative techniques and ideas. Unfortunately, because I have been involved in teams doing translations of technical materials, through reading lots of other works on technical writing, and gaining actual experience (often painful), I have already become familiar with solutions to most of the issues raised by the authors.

I would say that this book is something of a cross between Handbook of Technical Writing, Ninth Edition, Word 2010 For Dummies (For Dummies (Computer/Tech)), and The Elements of Style: 50th Anniversary Edition, with an admixture of miscellaneous technical writing tips targeting those in academia. I think it would be great if the authors could find a way in future editions to offer advice that might aid more experienced team writers; perhaps an extended explanation of a project in which they had been involved, with examples (false starts, mistakes, solutions, etc.) included for the whole process from the start of a project to its completion.


INEXPERIENCED WRITERS

If you have little or no experience in working as part of a team, then you will want to purchase this, for all of the reasons that I did not recommend it for experienced collaborative writers. It gives you the basics, and clearly explains how to use them in a group context. Although I won't say that it will replace works like the ones I linked to above (you can never have too many reference works!), it will quickly get you up to speed with what you need to know, and most importantly, you can avoid some of the more painful lessons that can make team work such a nightmare. There is pretty much something in every chapter that I wish I would have known when I was first getting started. One suggestion I have for future editions of this book, though, is to include the tables and charts in the appendices so that readers won't have to stick annoying yellow post-it notes on pages 45-46 (keyboard shortcuts), page 130 (copyediting and proofreading markup), etc.


SUMMARY

The book is an up-to-date and concise introduction to technical writing in teams. Ideally, everyone you are working with will have read the book, or at least be familiar with its main points. The authors also have a website available at "streamtools.org" with some supplementary information and materials.

Disclosure: I received a free copy of the book for reviewing purposes. I am in no way associated with the authors or the institutions at which they teach.

contact us

Email: