When Technical Writers Don't Write Technically  

Technical writers are often asked to write more than just end-user manuals or online help systems. Due to company size, layoffs, or a lack of resources, the technical writer might also be expected to deliver marketing communication collateral, Web site content, training materials, and more. These additional tasks can daunt those who have not been formally trained in other writing styles or those who do not switch writing styles easily.

Statt, Ronald A. Intercom (2003). Articles>Writing>Style Guides>Technical Writing

Working with Government Documentation Standards: A Case Study  

This paper discusses the software development process at a particular government agency, the documentation standards used by that agency, the problems caused by these standards, and some of the solutions that have helped the technical communication there to work through the problems and still create documents of use to the reader.

Chiricosta, Tracey C. and Irene Lea Taylor. STC Proceedings (1993). Presentations>Documentation>Style Guides>Government

Writer's Handbook

We're pleased to offer some of the many instructional materials we've developed for our Writing Center teaching. As useful as we think these materials may be to you, though, we need to offer a few words of caution. There are limitations to these materials. Assignments vary. Different instructors want different things from student writers. What's appropriate and effective in one context, isn't necessarily so in others. So as you peruse what's here please understand that our suggestions may or may not apply to your writing situation. Please remember that handouts can give only a fraction of the customized guidance that an individual conference with a Writing Center instructor can provide.

University of Wisconsin (2001). Reference>Style Guides>Education>Writing

Writing Better Reports: A Handbook for Civil and Environmental Engineers  

Based on faculty concerns, this handbook offers guidelines and exercises to help you improve your technical style.

Adams, David. Michigan State University (2003). Reference>Style Guides>Writing

Writing Consistently Across Media: Ten Proofreading Tips

Last time I wrote about consistency in online writing. Soon after, I received an email from Leslie Drechsler, a reader in Tustin, CA: 'As a Marketing Communications Specialist, I'd love to hear your ideas on how to successfully implement consistency in an established business,' she wrote. 'I thought developing a company style guide would solve the problem. But perhaps there are other ways to approach it. 'Perhaps this could be the subject of another article.' Here's that article, Leslie.

Henning, Kathy. ClickZ (2001). Articles>Editing>Style Guides>Writing

Writing English for a Global Readership

As first-language English users we often need to communicate effectively with people for whom English is a foreign or a second language, for instance when conducting business internationally. The Internet, particularly, is a global medium of communication, and we cannot assume that everyone reads or understands English flawlessly.

Asterisks.com (1999). Reference>Style Guides>Writing

Writing Processes

Our Writing Guides help you locate information quickly on specific topics. These guides focus on a range of composing processes as well as issues related to the situations in which writers find themselves.

Colorado State University. Articles>Style Guides>Writing>Rhetoric

Writing Resources Online

This annotated directory features Web sites focusing on English grammar, concise writing, style and usage, the writing process, words, plain language, creativity, word play, action writing, reference sources, online writing experts, books on writing, and favorite fiction writers. You'll also find lists of Web sites on punctuation, avoiding bias, overcoming writer's block, spelling, vocabulary, and writing for the Web.

Garbl's Writing Center. Resources>Writing>Style Guides

Writing Revisable Manuals: A Guidebook for Business and Government

Writing Revisable Manuals–A Guidebook for Business and Government was written to help organizations prepare high quality manuals, quickly and inexpensively. There is a saying in technical writing that 'You can have it good, you can have it fast, or you can have it cheap. But you can’t have all three.' The goal of this guidebook is to show you how to have all three. Focusing on revisable manuals—the kind you can update easily—this guidebook takes you step-by-step through planning, writing, and producing manuals. If you are working on a manual for your organization, or will be in the near future, this guidebook is for you.

Duncan Kent and Associates Ltd. (2000). Reference>Style Guides>Documentation

Writing Style Guide

The following is a description of Florida Institute of Technology's in-house writing style for everything except technical papers and reports. This guide is set up alphabetically and contains listings that will allow you to standardize everything you write for the university. Reference materials include The Associated Press Stylebook And Libel Manual (Fully Revised and Updated 1998 Edition), Webster's Ninth New Collegiate Dictionary and McGraw-Hill Dictionary of Scientific and Technical Terms (Fourth Edition).

Florida Institute of Technology. Reference>Style Guides>Writing

Writing Styleguide  

Many individuals and organizations develop styleguides to provide standards for the development of publications. Styleguides give rules and examples of writing style, word use, grammar, punctuation, capitalization, and typographic conventions. These standards are used when writing all kinds of documents—manuals, newsletters, reports, proposals, letters, memos, and so on—to maintain consistency and quality. Our styleguide is organized alphabetically by keyword for quick reference.

Duncan Kent and Associates Ltd. (2002). Reference>Style Guides

Writing User-Friendly Documents  

The traditional way of writing government documents has not worked well. Too often, it has produced complicated, jargon-filled documents that have resulted in frustration, lawsuits, and a lack of trust between citizens and their government. To overcome this legacy, the documents writers have a great responsibility to communicate clearly. Studies show that clearly written regulations improve compliance and decrease litigation. Writing that considers our readers' needs and draws them into the regulatory process improves the relationship between the government and the public it serves. Clear correspondence reduces the burden on the public. It also reduces the burden on the agency because we don't have to deal with the consequences of unclear communication.

PLAIN (NPR) was.. U.S. Bureau of Land Management (2001). Reference>Style Guides>Writing

Review: You Send Me: Getting It Right When You Write Online  

This book addresses the issues of online writing and particularly writing e-mail, which should concern all us who spend a good chunk of our days in front of a computer screen creating and replying to e-mail messages. The book is structured in three parts: 'The virtual mensch,' 'Alpha mail,' and 'Words of passage.'

Crawley, Charles R. Technical Communication Online (2002). Articles>Reviews>Style Guides>Email

Updating a Corporate Style Guide: Process and Reality

Establish a company-wide team of writers and editors to process comments on the style guide. If applicable, aim for a geographically diverse group that represents all of your company's documentation groups.

Gelb, Janice and Alysson Troffer. STC Proceedings (2008). Presentations>Slideshows>Style Guides>Workplace

One Space Or Two Spaces?

When I began writing technical documentation and courseware for Guru Labs, I asked a question during training about whether we should be putting two spaces after a period, colon, question mark and exclamation point, or one. The answer shocked me, as I was hoping for the standard answer as a means of teaching the rest of my colleagues. The answer was ONE space, not two. Then, I listened to the argument.

Toponce, Aaron. Aaron Toponce (2008). Articles>Writing>Style Guides>Grammar

Review: The Global English Style Guide: A Review

Many good style guides exist. Why do technical writers need another style guide? Unlike other style guides, this book covers grammatical structures, not only particular terms. The book has more than 200 pages of text (plus 4 appendices) that give detailed explanations of both good practice and bad practice.

Unwalla, Mike. TechScribe (2008). Articles>Reviews>Style Guides>Globalization

How to Use the Bulleted Lists Properly in Your Technical Document?

Bulleted lists are important in technical writing. They summarize information in a manner that is easy to read and absorb. Use them whenever you can to get your information across quickly. Bullets are ideal for things-to-do, equipment, sets, collections, cooking ingredients, and all kinds of other lists.

Akinci, Ugur. Technical Communication Center (2009). Articles>Documentation>Style Guides>Technical Writing

Technical Writing Guide  

This set of guidelines was developed to help you understand the expectations for technical communication in CE 314K (Properties and Behavior of Engineering Materials). Successful technical communication requires practice. Therefore, you should allot sufficient time to write several drafts of each assignment before submitting the final version.

Hart, Hillary. University of Texas (2007). Reference>Style Guides>Writing>Technical Writing

A Guide to the Preparation of Theses and Dissertations in Science and Engineering  

This guide is intended to help you write the best thesis you can by anticipating and answering common questions about content, structure, format, figures, and language. We have also included some suggestions on how to manage the process of turning your research -- your testing and reading, your findings and conclusions -- into a clear, complete, well-written, and convincing thesis or dissertation.

Hart, Hillary. University of Texas (2005). Resources>Style Guides>Research>Engineering

Do I Really Need a Style Guide?

So, after all, I must follow those infernal style guides. I am straight-jacketed. Am I not?

Palagummi, Sharada. Indus (2009). Articles>Editing>Style Guides>Writing

A Web Policy is a Policy, Not a Standard

I've noticed recently that people (and organizations) often interchange the policies and standards labels as if there is no difference between them... like those who insist the Web and the Internet are the same. I'm not one for splitting hairs, but in this case, policies are truly not the same as standards and it's important to be clear about the distinction.

Koniezeski, Delia. WelchmanPierpoint (2009). Articles>Web Design>Style Guides>Policies and Procedures

Introduction to Basic Legal Citation

This introduction to legal citation is focused on the forms of citation used in professional practice rather than those used in journal publication. It aims to identify the more important points on which there is divergence between the rules set out in two common manuals and evolving usage reflected in legal memoranda and briefs prepared by practicing lawyers.

Martin, Peter W. Cornell University (2007). Reference>Style Guides>Legal

Review: The Global English Style Guide

A review of "The Global English Style Guide: Writing Clear, Translatable Documentation for a Global Market" by John R. Kohl.

Wenger, Andrea. Carolina Communiqué (2009). Articles>Reviews>Style Guides

The Missing Manual Authors’ Guide  

This Authors’ Guide tells you everything you need to know to write Missing Manual. It starts out by giving you a brief introduction to the Missing Manual way of explaining things and then takes you through the nitty gritty of style guidelines, figure formatting, and so on.

Missing Manuals (2009). Articles>Documentation>Style Guides>Technical Writing