Nature of Technical Writing/Ideas for Writing

image of technical writer at computerDid you know that you probably read or create technical communication every day without even realizing it? If you noticed signs on your way to work, checked the calories on the cereal box, emailed your professor to request a recommendation, or followed instructions to make a withdrawal from an ATM, you’ve been involved with technical communication.

The  Nature of Technical Writing

Technical writing is an audience-centered means of communication that provides a reader with clear and easy access to information. Technical writers recognize the importance of effective and efficient communication by providing documents written in specific formats, using unambiguous language to provide information.  Specifically, technical writing involves communicating complex information to a specific audience who will use it to accomplish some goal or task in a manner that is accurate, useful, and clear. When you write an email to your supervisor, develop a presentation or report, design a sales flyer, or create a webpage, you are a technical communicator.

The Society for Technical Communication (STC) offers the following definition of technical communication:

Technical communicators research and create information about technical processes or products directed to a targeted audience through various forms of media. For example, STC members communicate about technical or specialized topics, such as computer applications, medical procedures, or environmental regulations. They communicate by using technology, such as Web pages, help files, or social media sites. And they provide instructions for products and services….The value that technical communicators deliver is twofold: They make information more useable and accessible to those who need that information, and in doing so, they advance the goals of the companies or organizations that employ them. (https://www.stc.org/)

example of technical writing

Look at an example of a piece of technical writing, a page on Climate Change Science Overview from the U.S. Environmental Protection Agency.  Think about this example:

  • Who is the target audience?
  • What information does this document provide?
  • What task or goal will it help to accomplish?
  • What elements of this document do you think make it useful?
  • Does it solve a problem? What writing style did the author use for this government document?
  • Is it concise and accurate?

Also look at the annotations in the margins of the document. Do you agree that this is an effective document? Why or why not?

As you can see from the example above:

  • Technical communication serves a practical purpose. In the case of the example, the purposes are to inform, instruct and, perhaps as a secondary purpose, to persuade.
  • Technical communication may address multiple audiences. Technical communicators must be conscious of intended and unintended audiences, foreign and domestic readers, and individuals with vastly differing responsibilities, experiences, and expectations of a given document. The context in which a document is read will differ with each reader and it is important to keep documents concise and free of bias and excessive or unclear language to ensure that they are understood.
  • Technical communication is collaborative. The sample document, at the very least, required collaboration between scientists and writers.
  • Technical communication is shaped by conventions and culture as well as audience needs. Organizations may be formal and conservative or informal and innovative, and technical writers reflect this orientation in their communication style.

In the video below, employees in various fields offer reflections on the importance of technical communication.

Interesting Information: Origins of Technical Communication

According to the Society for Technical Communication, technical communication’s origins have actually been attributed to various eras dating back to Ancient Greece (think Rhetoric!) and to the Renaissance, but what we know today as the professional field of technical writing began during World War I from the need for technology-based documentation for military and manufacturing industries. As technology grew and organizations become more global, the need and relevance for technical communication emerged. In 2009, the U.S. Bureau of Labor Statistics recognized Technical Writer as a profession (STC).

Ideas for Writing

By definition, technical writing courses are opportunities to focus on practical uses of your writing skills. Ideally, you’ll have appropriate work or community-related writing projects to write about, for example, instructions for installing new software, recommendations on alarm systems, procedures for hiring new personnel, or procedures and laws for public gatherings. However, technical writing courses are also great opportunities for exploring science, technology, and any other topic appropriate to technical writing tasks, for example, the latest methods for hydroponic gardening, the evolving and available research on pandemics, or a comparison of software applications based on usability.

The following are suggestions only, to spark your own thinking about possible topics for technical writing.  Again, the best topics and situations for technical writing are things that you really need to accomplish at work or in your community.

Workplace Ideas for Technical Writing Projects
What’s going on at work? Are the projects there, just waiting for you? Browse some of these ideas:
Does the organization want a social media presence, and need recommendations about the benefits and detriments of various social media for a particular purpose and audience?
Is it feasible to consider a change in software?
Do employees need fuller description of a particular part of a machine, and/or instructions on how to install or service this part?
Do employees need descriptive information about what a new safety procedures is and does?
Is the staff expected to use a new software application for which there is no user guide?
Does the organization need to establish procedures for telecommuting? For video conferences? For ???
Have there recently been complaints from end users about lack of useful documentation in code, and clarity of code?
Do you need to update documentation about storing and searching for information since existing information is old, from when the office went paperless a few years ago?
Have you been tasked with recommending a cell phone or laptop for all employees in your company?
Do you need to do a webinar training new employees in a particular process or procedure?

 

Community Issues Appropriate for Technical Writing Projects
Are there community issues that need action?
Inadequate public transportation Lack of parking Overflowing land fills
Smog and otherwise dirty air Crowded streets and highways Crime, vandalism
Homeless people Lack of daycare facilities Unemployment
Lack of low-cost housing Dwindling water supplies Expensive electricity
Natural areas threatened by urban development Lack of parks and recreational facilities Lack of facilities for the elderly
Rodent infestations Mosquitoes Lack of vegetation (trees, shrubbery, etc.)
Projects for nonprofits Lack of facilities for young people Expensive water

 

Topic Ideas for Technical Writing Courses
Is there a science, technical, communal, or medical topic you want to research or inform others about?
Science Topics
Global warming Wind energy Solar energy Industrial waste disposal
Hydroponics Black holes Thermal power Fish contamination
Bioengineered foods Earthquakes Industrial safety Pandemics
Technology Topics
Computer code Computer animation Fiber optics Computer audio
Virtual reality Artificial intelligence C++ programming Java programming
Ethical issues in IS/IT Legal issues in IS/IT Management information systems
Community Topics
Recycling
Mass Transportation Business needs School district budget
Single-use plastics Children-at-Play signs Community policing Independence Day celebrations
Overflowing landfills Air quality Urban development & ecosystems WiFi access
 
Medical Topics
Medical lab technology Pandemics Vitamin therapies Physical fitness technology
Sickle cell anemia Dyslexia Communal health resources Radiographic imaging