Consistency and why it matters

In technical writing, we are often writing for readability. In other words, your reader likely isn’t reading your document for fun. Rather, they have a purpose. For example, a grad student reading an academic journal article might need to understand a complex data analysis technique or interpret a trend line on a graph. Alternatively, a funding committee member reading a grant application might need to understand the applicant’s problem and proposed solution in order to recommend the proposal for funding. In both cases, the writing must be clear and tailored to the reader.

While there are many ways to improve readability, a great first step is to ensure you’re using consistent terminology throughout the entire document. This technique is straightforward to implement and delivers a lot of value for minimal effort. It’s easiest to start thinking about consistency during your planning stage, before you start writing:

  1. Think about key terms you will be using frequently;

  2. Choose a best practice for how you will refer to them; and

  3. Make a cheat sheet.

Not only does this help the reader avoid confusion, but it also supports collaborative writing because everyone on your team will say it the same way.

Rethinking citations

Pet peeve: "I'm not a writer!"