Technical Writing: What is It?
While technical writers need good computer skills, they do not necessarily have to write about computers all their lives. "Technical" comes from the Greek techne, which simply means "skill".
Every profession has its own special specialized forms of writing. Police officers, lawyers and social workers all write specialized reports -- and someone has to learn, perform, critique, and teach each one. Every major politician hires staff members to design, administer, and analyze surveys -- and to write the secret reports that get leaked to reporters. Somebody has to design tax forms and the accompanying instruction books, assembly instructions for toys, and scripts for product demonstrations or multimedia presentations.
For a large project, a technical writer may work with a graphic designer, an interface designer, several computer programmers, and a staff of freelance writers to design a huge web site. For a small project, or for a small company, the tech writer may be expected to do all of the above, all alone.
The first rule of technical writing is "know your audience." Writers who know their audiences well are in a position to suggest and implement solutions to problems that nobody else identifies. Whenever one group of people has specialized knowledge that another group does not share, the technical writer serves as a go-between. But technical writers are not just translators, accepting wisdom from experts and passing it on unquestioningly; they also are in the business of generating truth, by choosing what gets written, and for whom, with the full knowledge that later readers will depend on the accuracy of what has been written.
Whoever writes the first draft sets the agenda.
- Whenever I find myself writing the first draft of a collaborative document, about 80% of it gets published more or less as I drafted it. When other people show me their first drafts, I tend to change very little -- unless I really care about the topic, or I have a lot of time on my hands.
- My sister is a computer programmer who, when she just started out, happened to distinguish herself by being very good at taking notes during meetings. Her colleagues began stapling her notes to the official minutes. As a result, she was in a key position to resolve disputes about what did or didn't happen at a particular meeting, or to offer opinions about how a particular project was progressing. (These are the skills that enable employees to move out of the cubicles and into the offices with windows.)
- On the web, where the most senior people in an organization typically spend the least time on the Internet, younger webmasters can have a disproportionately large effect on the way the world perceives the organization.
- The web is mostly words. See: How Users Read on the Web.
Technical editing may involve working with brilliant researchers and scientists, who may be world-class experts in fluid dynamics or swine reproduction, but who may not know a paragraph from a participle. Some of these will be eternally grateful for your help, and others may resent your interference.
Good technical writers are also good teachers. They excel at explaining difficult concepts for readers who will have no time to read twice. Technical writers have an excellent eye for detail. They know punctuation, syntax, and style, and they can explain these rules to authors who need to know why their drafts need to be changed.
Although they typically work on their own for much of the time, they also know how to coordinate the collaborative work of graphic artists, programmers, marketers, printers, webmasters, and the various "subject matter experts" (SMEs), who know all the answers but have never bothered to write them down anywhere.
- Technical What? A sampling of technical writers describe their jobs.
- Beginners Start Here: Basic introduction to technical writing.
- Society for Technical Communication: "...the largest professional organization serving the technical communication profession."
- Jobs and Salary Information (STC)
- Tina the Tech Writer: She's brittle... she's stressed... she's a cartoon character.
- TECHWR-L: Home page for the technical writing mailing list.
- Usability Testing: 8 Quick Tips for Designing Tests
If you already have a prototype and you want to conduct a usability test, and you're eager to learn how to make the most of your opportunity to learn from your users, then this document is for you. Keep...
- Quotations: Integrating them in MLA-Style Papers
The MLA-style in-text citation is a highly compressed format, designed to preserve the smooth flow of your own ideas (without letting the outside material take over your whole paper). A proper MLA inline citation uses just the author's last name and the page number (or line number), separated by a space (not a comma).
- Show, Don't (Just) Tell
Don't just tell me your brother is funny... show me what he says and does, and let me decide whether I want to laugh. To convince your readers, show, don't just tell them what you want them to know.
There. I've just told you something. Pretty lame, huh? Now, let me show you.
- Titles for Web Pages: In-Context and Out-of-Context
Most writers know the value of an informative title, but many beginning web authors don't know that each web page needs two kinds of titles. The in-context (IC) title always sits at the top of a page, with the rest...
- Active and Passive Verbs
Active verbs form more efficient and more powerful sentences than passive verbs. This document will teach you why and how to prefer active verbs. * The subject of an active sentence performs the action of the verb: "I throw the ball." * The subject of a passive sentence is still the main character of the sentence, but something else performs the action: "The ball is thrown by me."
- Blurbs: Writing Previews of Web Pages
On the Web, blurbs are compressed summaries of what a reader will find on the other end of a hyperlink. Good blurbs don't harangue ("Click here!") or tease ("Learn ten great tips!"). You're reading a blurb now. If it helps you decide whether to click the link, it's done its job.
- Short Stories: Developing Ideas for Short Fiction
A short story is tight -- there is no room for long exposition, there are no subplots to explore, and by the end of the story there should be no loose ends to tie up. End right at the climax, so that the reader has to imagine how a life-changing event will affect the protagonist.
- Short Stories: 10 Tips for Creative Writers (Kennedy and Jerz)
Short stories make every word count. They avoid unnecessary scenes, characters, and plot points. It usually focuses on a single problem and a short time period. This page offers tips on writing dialogue, building to a climax, and capturing the reader's interest.
- MLA Style: Step-By-Step Instructions for Formatting MLA Papers
Need to write a paper in MLA format? This step-by-step includes images showing how to use MS-Word to create the title block, page layout, and works cited list.
- Writing Effective E-Mail: Top 10 Tips
People decide to read or trash e-mails in seconds. From the subject line to the closing, offer a focused, scannable message that puts your reader's needs first.