Find Jobs
Hire Freelancers
与 Ava 聊天 - 您的人工智能业务顾问
用户头像
大家好,我是 Ava,您的 AI 指南,可帮助您增强业务!
无论您已经在经营一家企业还是梦想创办一家企业,我们都会用AI赋能威客帮助您将愿景变为现实。分享您的业务目标,我们将共同创建一个项目,供我们才华横溢的威客竞标。让我们让您的愿景成为现实!
我已经有一份事业
我要创业
将对话发送到您的电子邮件时出现问题。请稍后再试。
您每小时只能保存一次对话。请稍后再试。
你们的谈话太短了。继续与 Ava 聊天以启用保存功能。

6 tips to make you a great technical writer

Technical writing doesn't have to be dry and dense. Follow our guidelines to help make your tech content actually enjoyable to both write and read.
2019年6月3日 • 阅读需4分钟
由Adam S.于2020年1月21日进行更新
封面照片

Explain complex concepts without putting your readers to sleep

Technical writing is a difficult discipline. By definition, technical writing is producing instruction manuals, how-to guides and supporting documents to communicate technical information. It tries to put highly technical subject matter into a format that readers can easily understand. For a writer, this is no easy feat.
But technical writing is a great industry for talented writers. According to the US Bureau of Labor Statistics, the median pay for a technical writer is $71,850 USD per year.
Technical writing is a growing field as well. The demand for technical writers is projected to grow by 11% by 2026. If you're a professional writer, using your skills as a technical writer can lead to a lucrative career.
Getting into technical writing can seem intimidating. Disseminating complicated information for easy digestion is difficult. But if you follow these tips, you can produce engaging copy that helps and informs your readers.

Freelance Freelance Writing Experts

用户头像
的国旗 Samina K.
10 USD / hour
4.8 (631条评论)
Translation
Internet Marketing
Project Management
Research
Proofreading
Visit profile
用户头像
的国旗 David Dundas
35 USD / hour
5.0 (1258条评论)
Copywriting
Legal
Internet Marketing
SEO
Research
Visit profile
用户头像
的国旗 Rana Shakoor A.
18 USD / hour
5.0 (17条评论)
Data Entry
Excel
WordPress
Powerpoint
Financial Research
Visit profile
用户头像
的国旗 Jonathon B.
25 USD / hour
4.9 (42条评论)
Copywriting
Facebook Marketing
Blog
Marketing
Editing
Visit profile

1. Know your audience

First and foremost, think about who will be reading the materials you produce. Try to understand the audience you're writing for. This will determine how you write the materials.
For example, if the training manuals you're producing will be used by software engineers, it's likely you won't have to spend time defining concepts like code linting or integrated development environments. You'll be able to assume a certain base level of knowledge and can focus on explaining unfamiliar concepts rather than retreading already familiar ground.
You also need to understand how your audience will be using the document. What goal will they be trying to accomplish by reading your documentation? What questions will they be asking? When will they be reading the document, and why? Knowing how your document will be used dictates how it will be written.

2. Map out your piece

Mapping out your work is crucial in technical writing. You're trying to explain a process or use case. This means you have to think about the order in which information must appear.
Break down the goals of the document into individual tasks. What tasks must the reader perform in order to master the concept or process you're communicating? What information will they need to perform these tasks? Structure your document to flow in the order in which an actual reader will have to perform tasks.

3. Talk to experts

One of the biggest challenges in technical writing is gaining an understanding of the subject matter. You can't very well explain a process or concept to a reader if you don't understand it yourself. This is why consulting experts is invaluable.
Talk to the people who actually designed the process you're trying to explain. Find out why they designed it the way they did, and how they envisioned others using it. If possible, watch them actually use the product or platform you're writing about. Think about the questions you have after watching them. If you have these questions, it's likely your readers will too.

4. Be clear and specific

Don't leave room for doubt when describing a task or process. For instance, rather than writing "hold the power button down until the light flashes," write, "hold the power button down firmly for five seconds until the green power light flashes three times."
Technical writing is not the place for ambiguity. Use measurable terms and specify quantities and times.

5. Be concise

Try to explain concepts using as few words as possible. Write in simple, declarative sentences and use active rather than passive voice. Remember that you're trying to simplify a concept or process. When this is your goal, success is measured in using as few words as possible to do this.
Think about the information that's vital for your reader to achieve their goal. Narrow down your document to include only this information and get rid of anything extraneous.

6. Use plain English

This might be the single most important skill to master in technical writing. After all, the purpose of technical writing is to make complex concepts and processes easy to understand. If the language you use is overly obtuse, you'll only succeed in confusing your audience further.
This doesn't mean you have to avoid jargon altogether. What it does mean is that you need to understand the jargon with which your audience will be immediately familiar, and avoid any that will be unfamiliar to them. When in doubt, err on the side of using layman's terms.
Define any unfamiliar terms or acronyms the first time they appear in the text. Use familiar and common words in place of longer or more complicated words. While your instincts as a writer may drive you towards impressing the reader with your vocabulary, keep your hands off the Thesaurus. In technical writing, loquaciousness is not a virtue.

Freelance Freelance Writing Experts

用户头像
的国旗 Muhammad Naeem S.
100 USD / hour
5.0 (343条评论)
Copywriting
Translation
Audio Services
Research
Proofreading
Visit profile
用户头像
的国旗 Ahmed M.
100 USD / hour
4.9 (542条评论)
Copywriting
Translation
Legal
Photography
Research
Visit profile
用户头像
的国旗 Mark H.
30 USD / hour
5.0 (1490条评论)
C Programming
Python
Visual Basic
Copywriting
Legal
Visit profile
用户头像
的国旗 Mac Wheeler
30 USD / hour
5.0 (138条评论)
Copywriting
Internet Marketing
Research
Proofreading
Blog
Visit profile
告诉我们你需要做什么
输入您的项目名称
开始项目
相关故事

与我们的Technical Co-Pilots进行沟通来获得项目帮助

立即获得帮助

专为您推荐的文章

文章缩略图 Planning your startup
Our ultimate guide will help you write a business plan investors will be ripping out of your hands. Learn how to expertly craft each section of it.
22 min read
文章缩略图 10 local SEO tips you can't afford to ignore
Local SEO helps your business get noticed and sends customers to your door. We've got 10 superb local SEO tips you need to start implementing today.
6 min read
文章缩略图 2020 SEO Guide: How to write website content
Need to write content for your website? Follow our guide to make sure it's optimized to rank on the first page of Google
20 min read
文章缩略图 How to use Google Search Console to track your SEO
Google Search Console is an essential to monitor your SEO effectiveness and if it confuses you, you're not alone. We've demystified this tool for you.
5 min read
谢谢!我们已通过电子邮件向您发送了索取免费积分的链接。
发送电子邮件时出现问题。请再试一次。
已注册用户 发布工作总数
Freelancer ® is a registered Trademark of Freelancer Technology Pty Limited (ACN 142 189 759)
Copyright © 2024 Freelancer Technology Pty Limited (ACN 142 189 759)
加载预览
授予地理位置权限。
您的登录会话已过期而且您已经登出,请再次登录。