IDS Documentation Tips

A minimalist style is very useful in technical writing. We seek to take complex topics and subject matter, and break them down into something easily digested and understood. Run-on sentences and poor use of coordination can lead the reader on a frustrating chase...

In most cases documentation and technical writing often comes after the fact or prior to an event happening. In these cases, we see functional design specifications showing equipment functionality, or a report crafted after an event has occurred. There are cases,...

Brushing up on basic writing skills is always a good idea. With all the different instances of capitalization in our documents, it is a good idea to revisit it often. Here are some tips on capitalization. Units of Measurement A good rule of thumb to follow when faced...

Proper grammar in any style of writing is not like riding a bike; if you leave it for a while it is hard to pick it back up. Comma use is particularly susceptible to this. It often feels like no matter how much we write, we can always stand to revisit comma use. Here...

The semicolon is often left out because the writer is unclear on how to use it. In other cases, the semicolon gets used when a simple period would suffice. In technical writing, the semicolon can be a powerful tool but it can also hinder effective writing. Let's look...

Email is a major realm of technical communication that almost every company takes for granted. Even at AKA, we are often inundated with email to a point where responses become more of a reflex than a message that is well thought out. But there are a few ways that...

Getting into a rhythm when writing is always good and can lead to a lot of great content. However, it is important that we do not lose sight of our audience throughout this process. This begins to happen when we stop using specific nouns. Here are a couple of...

The idea of having a voice in writing is not restricted to creative works. Making sure that the voice we use in our writing is appropriate for the application is important. It is also important to keep that same voice throughout the document. Here are some tips on...

Accessibility is a pillar of great technical documentation and should be considered always when developing informative content. Here are some tips and strategies to ensure the documentation you create suits your audience. Legible Figures and Charts When writing a...

We often get wrapped up in producing documentation quickly to satisfy the next milestone or to meet a deadline. When we do this the concept of writing to an audience is sometimes lost. Here are some tips on writing for the reader instead of the job. Keeping the...

How do you control the sources of variability and failure within your processes? The quality of an output from a process can be directly attributed to the sources of variability within the process. A Standard Operating Procedure (SOP) is one of the most cost-effective...

Documentation in any workplace is rarely consolidated into one area. In an engineering firm, technical documentation services are a key element of the business. Our IDS (Integrated Documentation System) exists to fill that business need, but documentation exists at...