GrammarPhile Blog

10 Best Practices for Writing and Editing Technical Documents

Posted by Phil Jamieson   Feb 14, 2019 7:00:00 AM

As technology and science become more pervasive and important in our everyday lives, expertly edited technical documents will become more and more in demand. They’re important to businesses, organizations, and consumers alike.

Whether you’re a novice or you’ve written and edited technical documents for decades, here are 10 best practices you’ll want to keep in mind.

1. Know Your Audience and Write Exclusively for Them and to Them

When writing or editing technical documents, it’s essential that you first understand your target audiences and their backgrounds and preferences, and that you conduct research and collect data about them.

For example, some things you’ll want to consider:

  • whether your document is aimed at marketers who are new to your organization
  • whether you’re writing a user manual for common consumers with little to no experience with your technology platform
  • whether you’re writing a manual for experienced coders who already use your technology platform on a deeper level

Essentially, it’s imperative that you understand your audiences’ demographic information and backgrounds, and that you cater your technical content to suit their needs and preferences. Otherwise, it will be impossible or challenging for them to understand, and it will not end up being helpful.

Also, be sure to use “you” and speak to your audience directly in your technical documents and provide plain and simple actions for them to take. Basically, remember to always provide your audience with helpful information in a way that’s easy for them to follow.

Read More

Topics: technical writing, technical editing

10 Commandments of Technical Writing

Posted by Phil Jamieson   Jul 6, 2017 7:30:00 AM

Writing a manual or instruction booklet for new team members or customers is difficult. You want them to get acquainted with your product or service in a positive way, while providing them with valuable information. But you don’t want to bore them or scare them away with complicated details.

Read More

Topics: technical writing

Don’t Be Fooled by False Subjects

Posted by Terri Porter   Jan 21, 2015 7:00:00 AM

Because January is a big month for exercise resolutions, our posts this month focus on whipping your writing into better shape.

Read More

Topics: business writing, technical writing, government writing, financial writing, scientific writing, legal writing

Subscribe to Email Updates

Sign up for our emails!

Sign Up

Search Our Blog

Recent Posts

Posts by Topic

see all