Comprehensive Editing: Why You Can’t Do It Alone

notepad

The ultimate goal of your published work goes far beyond being grammatically correct. The ultimate goal is to be correct—in all ways. Herein lies the need for comprehensive editing (also called substantive editing). Comprehensive editing includes copy editing, as editing for content and clarity, so that you achieve your documentation/publication goals: Accuracy Clarity Conciseness Correctness […]

How to Avoid Common Stylistic Problems in Technical Writing

pencils

Technical writing isn’t just about writing on technical topics. It also includes writing in a style that allows your readers to quickly and easily understand technical information and put it to work. When writing has errors—grammatical, mechanical, or stylistic—meaning suffers and readers get lost. Many unskilled writers may write grammatically and/or mechanically correct documents that fail […]

Part II: Best Technical Writing Tools—Technical Skills

typing

You may be intrigued by the state-of-the-art electronic device you just bought—the technology, the innovation, the research and development. But have you taken into consideration what’s behind the documentation that came with the product? The writer, the tools, the training, the experience—these all are a part of the document you’re holding in your hand. A […]

Part I: Best Technical Writing Tools—Personal Skills

Hand over keyboard

You may be a high school student on the verge of entering college. Or, perhaps you’re a seasoned professional looking for a career change. Regardless of the specific scenario, when you’re considering a career in technical writing, you should seek to own the same skills—both technical and personal—that every successful technical writer has. Below are descriptions of […]

Part II: How a Technical Writer Can Save You Money—The Hidden Costs of Outdated Technical

helpdesk

Part One of How a Technical Writer Can Save You Money discussed how a technical writer can reduce your help desk support. But another way a technical writer can save you money is by ensuring your documentation remains current. Outdated technical documentation can cut into your profit in many ways and, in extreme cases, can lead […]

Part I: How a Technical Writer Can Save You Money—Reduce Your Help Desk Support

money

That product you’ve been working on—the one you’ve poured your heart and soul into—has a beginning. Maybe it was the day the idea was born or perhaps the day the idea was approved for production. And since that time, many hours of research, development, and testing have gone into the product. Then, finally, you reach […]

Why Developers Shouldn’t Write User Documentation

pen [640x480]

Product developers serve a very important purpose in today’s world. Through trial and error, developers use a range of skills to create a valuable product for consumers. In an effort to make the product as desirable as possible, developers maximize the product’s features—for example, by making it energy efficient, cost effective, multi-purpose, or low maintenance. In short, […]

7 Tips to Creating a Usable Technical Document

binders2

For a technical document to be of use to its intended audience, its contents must be accessible. Since most technical documents aren’t intended to be read from beginning to end, the reader must be able to easily and accurately locate the specific information he or she needs. Key document accessibility features may include A table of […]

7 Tips for Interviewing and Hiring a Technical Writer

interview

Hiring a technical writer can make or break your project—hiring the right person can make your project run like a well-oiled machine; hiring the wrong person can lead to project delays, no doubt breaking your project’s budget. When interviewing and hiring a technical writer, consider these seven tips: Clearly Define Your Needs For many industries, […]

When Should I Hire a Technical Writing Service?

user manual

If your company produces any type of documentation—whether it’s proposals, user manuals, or training materials—you need the expertise that only a technical writing service can offer. A technical writer will ensure your documentation is accurate, easy to read, and user friendly so that your company appears competent and professional. And that’s important because the documents that […]