Every genre of writing has unique characteristics and rules, called conventions, that help readers classify a document as belonging to a particular genre. This also applies to film and music. Think about the last movie you saw. What type of movie was it? What about that movie gave you that impression? Did the characters wear Stetson hats, ride horses, and carry guns? Did they fly in space ships, encounter alien beings, and use futuristic technology? Those elements are typical conventions of Western and Science Fiction genres.
Non-fiction is a category that can be broken into various genres. The main genres that are relevant to us are journalism (newspaper writing), academic writing (written by scholars and published in peer reviewed academic journals or books), and technical writing. Before we get into the specific conventions that characterize technical writing, take a moment to think back to your academic writing course and list some conventions typical of journalism (popular press) and academic writing in Table 1.1.1.
Like journalism and scholarly writing, technical writing also has distinct features that readers expect to see in documents that fall within this genre. These include (a) use of headings to organize information into coherent sections, (b) use of lists to present information concisely, (c) use of figures and tables to present data and information visually, and (d) use of visual design to enhance readability (all of these topics are covered in Chapter 3: Document Design). These conventions are connected to the main purposes of technical writing, which include communicating the following:
- Technical or specialized information in an accessible and usable ways
- Clear instructions on how to do something in a clear manner
- Information that advances the goals of the company or organization.
Technical documentation is intended to communicate information to the people who need it in a way that is clear and easy to read, at the right time to help make decisions and to support productivity. Designing technical communication is like designing any other product for an intended user: the ultimate goal is to make it “user friendly.”
Key words here are accessible, usable, clear, goal-oriented, effective, and reader-centred. The characteristics of technical writing support these goals and concepts.
If we filled in Table 1.1.1 with typical characteristics of technical writing, it might look something like Table 1.1.2:
|Purpose||To communicate technical and specialized information in a clear, accessible, usable manner to people who need to use it to make decisions, perform processes, or support company goals.|
|Audience||Varied, but can include fellow employees such as subordinates, colleagues, managers, and executives, as well as clients and other stakeholders, the general public, and even readers within the legal system.|
|Writing Style||Concise, clear, plain, and direct language; may include specialized terminology; typically uses short sentences and paragraphs; uses active voice; makes purpose immediately clear.|
|Tone||Business/professional in tone, which falls between formal and informal; may use first person or second person if appropriate; courteous and constructive.|
|Structure||Highly structured; short paragraphs; clear transitions and structural cues (headings and sub-headings) to move the reader through and direct the reader.|
|Format/Formatting||Can be in electronic, visual, or printed formats; may be long (reports) or short (emails, letters, memos); often uses style guides to describe required formatting features; uses headings, lists, figures and tables.|
|Other Features||Typically objective and neutral; ideas are evidence and data-driven; descriptors are precise and quantitative whenever possible.|
Use this practice activity to test your understanding.
H5P: Conventions and Characteristics based on Table 1.1.2
Review the conventions of technical writing and then use your knowledge to match the appropriate word into the correct blank.
Words: format, audience, quantitative, structured, objective, tone, evidence-based, writing style, purpose.
- The of technical writing is to communicate technical and specialized information in a clear, accessible, usable manner.
- The varied might include fellow employees as well as clients, other stakeholders, the general public, and even readers within the legal system.
- This requires a concise, clear that uses plain and direct language. It typically uses short sentences and paragraphs, the active voice, and a clear purpose.
- Written in a business/professional which lies somewhere between formal and informal, it is always courteous and constructive.
- With short paragraphs, clear transitions, and structural cues such as headings and sub-headings, technical writing is highly .
- The can be electronic, visual, or printed. It may be long such as reports or short as in emails.
- Technical writing is typically and neutral. Ideas are and data-driven. Descriptors are precise and whenever possible.