Technical Writer

A hypertext encyclopedia entry about technical writers, with links to many related topics.

Wikipedia. Reference>Encyclopedias>Writing>Technical Writing

Uniform Requirements for Manuscripts Submitted to Biomedical Journals

A small group of editors of general medical journals met informally in Vancouver, British Columbia, in 1978 to establish guidelines for the format of manuscripts submitted to their journals. The group became known as the Vancouver Group. Its requirements for manuscripts, including formats for bibliographic references developed by the National Library of Medicine, were first published in 1979. The Vancouver Group expanded and evolved into the International Committee of Medical Journal Editors (ICMJE), which meets annually; gradually it has broadened its concerns.

International Committee of Medical Journal Editors (2002). Reference>Writing>Scientific Communication

Using American Psychological Association (APA) Format

For the most current information about APA Format, we recommend visiting the Author's Corner of the APA website, where you can read about electronic reference formats recommended by the American Psychological Association and some frequently asked questions about the APA Publication manual, which includes the most up to date information about formatting, citation, and style. This handout is currently being revised to be in accordance with the latest guidelines, so do make sure to check our information against theirs.

Purdue University. Reference>Style Guides>Writing

Using Modern Language Association (MLA) Format

Modern Language Association (MLA) format provides writers with a system for cross-referencing their sources--from their parenthetical references to their works cited page. This cross-referencing system allows readers to locate the publication information of source material. This is of great value for researchers who may want to locate your sources for their own research projects. The proper use of MLA style also shows the credibility of writers; such writers show accountability to their source material. Most importantly, the use of MLA style can protect writers from accusations of plagiarism--the purposeful or accidental use of source material by other writers without giving appropriate credit.

Purdue University. Reference>Style Guides>Writing>Plagiarism

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 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 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 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

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

Quick Reference Guides: Short and Sweet Documentation

In this article, my colleague and I provide strategies, tips, and approaches we’ve learned in creating quick reference guides for software documentation projects.

Johnson, Tom H. I'd Rather Be Writing (2009). Articles>Documentation>Technical Writing>Quick Reference

Quick Reference Guides: Short and Sweet Technical Documentation  

Users often want documentation in a format that will give them the basics and get them on their way as fast as possible. Quick reference guides provide a short version of a manual, condensed from dozens or hundreds of pages down to just one double-sided sheet of paper. Despite the brevity of quick reference material, the thought process involved in creating, organizing, and laying out the content is time consuming. The format requires you to assess the content and decide the most important information the user needs to know. You must describe with extreme concision and clarity processes that usually require dozens of pages to explain. This article provides an overview of the strategies, tips, challenges, and benefits we have learned in using quick reference guides for our documentation projects.

Johnson, Tom H. and Benjamin Minson. Gryphon Mountain (2009). Articles>Documentation>Technical Writing>Quick Reference

Starting Points with Quick Reference Guides: Gathering Before Designing

Dan Roam explains that drawing pictures can help you solve problems. He says the first rule is to “collect everything possible up front.” After collecting all your information, you then “lay it all out where you can look at it.” By laying out all the information, you can grasp the whole of it, make connections between various parts, see the important sections, and recognize patterns.

Johnson, Tom H. I'd Rather Be Writing (2009). Articles>Documentation>Technical Writing>Quick Reference

Quick-Start Guides Require a Minimalist Mindset

The point of a quick-start guide is, as the name says, to help the users get on their feet as fast as possible. This requires the writer to ask, “What is the absolute minimum that someone needs in order to get started?” The next best question is “What is the user going to do the most often?”

Minson, Benjamin. Gryphon Mountain (2008). Articles>Documentation>Technical Writing>Quick Reference

Quick Reference Guides Are More Useful Than a 150-Page User Doc 

I’m working on a project to boil a 150-page software user document down to a one-page reference guide that can be tacked to a CSR’s cube wall. Our goal with the one-page reference guide is to give the CSR a description of all the navigation elements and application functionality so they can quickly navigate to where they want to go without first having to trudge through the complete 150-page user doc.

Creel, Ron. Your Writing Dept (2009). Articles>Documentation>Technical Writing>Quick Reference