Find Jobs
Hire Freelancers
Chatea con Ava - Tu consultor de negocios IA
Avatar del usuario
¡Hola, soy Ava, tu guía de IA para potenciar tu negocio!
Ya sea que dirijas una empresa o sueñes con iniciar una, estoy aquí para hacer realidad tu visión gracias a los freelancers que usan IA. Comparte los objetivos de tu negocio y juntos crearemos un proyecto en los que nuestros talentosos freelancers puedan ofertar. ¡Hagamos realidad tu visión!
Tengo un negocio
Estoy comenzando un negocio
Algo salió mal al enviar la conversación a tu correo electrónico. Por favor, intenta de nuevo más tarde.
Solo puedes guardar tu conversación una vez por hora. Por favor, intenta de nuevo más tarde.
Tu conversación es demasiado corta. Sigue chateando con Ava para poder guardar.

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.
3 jun 2019 • Lectura de 4 minutos
Actualizado el 21 ene 2020 por Adam S.
 Foto de portada

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

Avatar del usuario
Bandera de David Dundas
35 USD / hour
5,0 (1267 comentarios)
Copywriting
Legal
Internet Marketing
SEO
Research
Visit profile
Avatar del usuario
Bandera de Isabelle Z.
60 USD / hour
5,0 (365 comentarios)
Copywriting
Internet Marketing
Data Entry
Research
Proofreading
Visit profile
Avatar del usuario
Bandera de Audrey V.
30 USD / hour
5,0 (529 comentarios)
Proofreading
Technical Writing
Editing
Word
Article Rewriting
Visit profile
Avatar del usuario
Bandera de Jonathon B.
25 USD / hour
4,9 (42 comentarios)
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

Avatar del usuario
Bandera de CleverPen Content
50 USD / hour
4,9 (798 comentarios)
Copywriting
Banner Design
Data Processing
SEO
Data Entry
Visit profile
Avatar del usuario
Bandera de GilbertBarry
25 USD / hour
5,0 (214 comentarios)
PHP
Graphic Design
Copywriting
Legal
Internet Marketing
Visit profile
Avatar del usuario
Bandera de Khurram A.
25 USD / hour
5,0 (117 comentarios)
Copywriting
Research
Proofreading
WordPress
Powerpoint
Visit profile
Avatar del usuario
Bandera de Krystal B.
15 USD / hour
4,9 (293 comentarios)
Copywriting
Data Entry
Research
Proofreading
Excel
Visit profile
Cuéntanos qué trabajo necesitas encargar
Ingresa el nombre de tu proyecto
Inicia tu proyecto
Historias relacionadas

Habla con uno de nuestros Copilotos técnicos para que te ayude con tu proyecto

Recibe ayuda ahora

Artículos recomendados solo para ti

 Foto de miniatura de artículo 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
 Foto de miniatura de artículo 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
 Foto de miniatura de artículo 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
 Foto de miniatura de artículo 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
¡Gracias! Te hemos enviado un enlace para reclamar tu crédito gratuito.
Algo salió mal al enviar tu correo electrónico. Por favor, intenta de nuevo.
Usuarios registrados Total de empleos publicados
Freelancer ® is a registered Trademark of Freelancer Technology Pty Limited (ACN 142 189 759)
Copyright © 2024 Freelancer Technology Pty Limited (ACN 142 189 759)
Cargando visualización previa
Permiso concedido para Geolocalización.
Tu sesión de acceso ha expirado y has sido desconectado. Por favor, inica sesión nuevamente.