When people hear the phrase technical writing, they often hear something like: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. The phrase is a bit of a black box—it seems to suggest specialized knowledge, in-the-know readers, and complicated style. But the real purpose of technical writing is to clarify--to clearly and efficiently transfer information to readers (see, for example, the inimitably easy-to-read Nikon D7000 User Manual): For most businesses, technical writing is obligatory work. Because few departments employ a dedicated technical writer, the task of writing guidelines, manuals, specs, directories, releases, and other informational or action-oriented material typically falls on the shoulders of the (collectively recognized) best writer on staff. Best writer on staff? We’re here to help. Successful execution of technical writing depends on five general principles: committing to the process, articulating the purpose, identifying the audience, determining the organizational schema, and using precise and concise language to convey the content. Let’s fill that out:
Technical writing can be intimidating—there can be reams of information to condense, and the stakes can be relatively high. (And then, of course, there are the not-at-all-insignificant elements of style and format.) But keeping these five principles in mind ensures that the best writer on staff approaches the project with confidence. Comments are closed.
|
![]() Jessica Knight
English PhD, former arts administrator, obsessive cook, native East Coaster, mom to two rabblerousers. Molly Gage
English PhD, former high school teacher, obsessive organizer, native Midwesterner, mom to three troublemakers. Archives
October 2019
Categories
All
|