No matter your industry, you’re going to need documentation to get your project off the ground. That includes the renewable energy sector. Much of this documentation is actually required by government agencies, including the BOEM. Here’s what you need to know about the BOEM, what can happen if you don’t have the necessary documentation, and…
What is plain writing or plain language? It may be easier to start with what plain writing is not. Plain writing is not simplifying all your documents to a certain reading level. It is also not a call to write condescendingly or provide a single format for all documents. Plain writing is a method of…
So you want to build a MS Word template and can’t decide on whether to use built-in or custom styles? Templates are great tools, especially if you are creating a series of documents that require the same structure, such as standard operating procedures (SOPs) or engineering standards. Defined styles, such as font size and color,…
Every now and then, we need to revisit the basic principles of technical writing. Since we started in 1997, the basic principles of technical writing have stayed the same, even as the modes of communication change. Purpose and Audience Before beginning any new writing project, a technical writer has to analyze the purpose for the…
How Consistently Designed Procedures Can Save Lives, Time, and Money What is a Procedure? Procedures are a series of steps followed in a regular, definite order, and most people complete the steps of multiple procedures every day. Whether they’re written down or internalized, procedures are organizational tools that help people safely and accurately complete tasks.…
Previous blogs introduced the idea of using structured folders and file sharing to help employees find documents more efficiently. This blog addresses the structure within a suite of documents, which is essential to helping employees find needed information more expediently. Documents can be classified in numerous ways, with the various document types requiring different information;…
Let’s talk about the intersection of document design and writing. The appearance (design) of how information is conveyed can either enhance or devalue the validity of the subject matter of a document. Different types of documents have different design requirements. For example, a technical manual that has casual or cartoonish graphics and is written as if…
How fast can you read the following words? Red Green Blue Yellow Purple Red Blue Yellow Purple That wasn’t too difficult, right? Okay, now try it again: Red Green Blue Yellow Purple Red Blue Yellow Purple This was a bit more difficult, but it wasn’t too bad. So, how about saying the color that each word is printed in instead? Blue Yellow Purple Red Green Red Blue Yellow Purple Ahh, you’re slowing down…