Characteristics of Technical Writing
Several authors (Alred, 2019; Markel, 2012; Pfeiffer, 2002) defined the characteristics of Technical Writing as:
· Purpose: Explaining how to complete a task or process (Putting together a bed frame, completing a project, applying for college)
· Knowledge of the topic: The writer knows more than the audience. Assume no prior knowledge.
· Audience: Several people of different backgrounds (Take the example of putting together a crib for the nursery. The person who purchases and is putting it together maybe a crafty mom, a dad who only deals with computers but is not so crafty with his hands, or an engineer. All of them might purchase the same crib.)
· Criteria for evaluation: Ideas need to be clear and organized. Simple to read.
· Statistical and graphic support: Explains existing conditions and presents alternatives based on data.
· Ethical: We have the legal obligation to be truthful in our technical writing. The steps need to be correct to avoid someone being hurt. Take the crib example above. If one of the steps of adding a particular screw is missed and the crib breaks when you lay down the baby, it could cost the baby’s life and have legal ramifications for the manufacturer.
Let’s look at a poem and how it is written in technical terms. Below is Robert Frost’s “The Road not Taken.” On the first column, you will see each of the poem’s verses, and on the second column, how it would be written in technical communications.
Comparison between Literacy and Technical writing
Literary Writing
Technical Writing
Two roads diverged in a yellow wood,
And sorry I could not travel both
And be one traveler, long I stood
And looked down one as far as I could
To where it bent in the undergrowth;
There are two roads.
You have to select one.
You looked as far as you could see.
Then took the other, as just as fair,
And having perhaps the better claim,
Because it was grassy and wanted wear;
Though as for that the passing there
Had worn them really about the same,
You decided to take the one that had more grass.
And both that morning equally lay
In leaves, no step had trodden black.
Oh, I kept the first for another day!
Yet knowing how way leads on to way,
I doubted if I should ever come back.
Once you decide on one road, you can’t go back to the other.
I shall be telling this with a sigh
Somewhere ages and ages hence:
Two roads diverged in a wood, and I—
I took the one less traveled by,
And that has made all the difference.
You took the grassier road.
Let’s read about the Code of Ethics that must be followed when writing a technical piece.
Code of Ethics in Technical Writing
The Society for Technical Communication (STC) enumerates six ethical principles of technical communications. These are:
1. Legality
2. Honesty
3. Confidentiality
4. Quality
5. Fairness
6. Professionalism
Visit the Society for Technical Communication (STC) site to read about the ethical principles: Ethical PrinciplesLinks to an external site. .
STC. (2021). Ethical Principles. Society for Technical Communication; P. Retrieved January 11, 2022, from https://www.stc.org/about-stc/ethical-principles/
References
Alred, G. J. (2019). The handbook of technical writing (12th ed.). Bedford/Saint Martin’s.
Annemarie, H. R. D. (2015). Technical writing. https://coccoer.pressbooks.com/Links to an external site.
Azusa Pacific Writing Center. (2018, December 18) What is Technical Writing? Youtube https://www.youtube.com/watch?v=9SB4tfD0hxM
Hamlin, A., Rubio, C., & DeSilva, M. (2015). Ethics in Technical Writing – Technical Writing. https://coccoer.pressbooks.com/chapter/ethics-in-technical-writing/Links to an external site.
Markel, M. (2012). Technical Communication (10th ed.). St Martin’s Press.
Pfeiffer, W. S. (2002). Technical writing: A practical approach (5th ed.). Pearson.
Race, C. (n.d.). Chapter 1: Introduction to Technical Writing. Open Technical Communication. Retrieved January 11, 2022, from https://alg.manifoldapp.org/read/open-technical-communication/section/0debb16b-f623-4033-a47b-973d65ab0961Links to an external site.
Society for Technical Communication. (2021, September 21) Defining Technical Communication. https://www.stc.org/about-stc/defining-technical-communication/Links to an external site.
STC. (2021). Ethical Principles. Society for Technical Communication; P. Retrieved January 11, 2022, from https://www.stc.org/about-stc/ethical-principles/Links to an external site.
L. M. Surhone, M. T. Timpledon, & S. F. Marseken, Eds. (2021). Defining Technical Communication. STC. Betascript Publishing.
Module 1: Introduction to Technical Writing
Introduction
Imagine explaining the use of PowerPoint and all its functions to someone who has never worked with the program in a written manual. Where would you start? For describing how to open the program, perhaps, followed by how to create new presentations, add images, or select font? How would you make sure that the student understands everything? For example, with the help of bullet points (step by step), screenshots, or images, for example?
This is a simple example of the questions that a technical writer has to deal with on a day-to-day basis. And not just technical writers, but anyone involved in writing documentation for (complex) technical processes such as reports, processes, or manuals. Technical writing means writing in a way that whoever your target audience is capable of understanding it – regardless of their background or background knowledge. But why is it so important? And what are the best practices when it comes to technical writing? During this course, you will have the opportunity to examine the different types of technical writing genres, compare and contrast with varying writing styles, and try a hand at writing your own in the form of a white paper.
Defining Technical Writing
Type in “Technical Writing” in Google, and you may find many definitions of technical writing or technical communications. The Society for Technical Communication (STC) is the world’s oldest specialized association devoted to developing technical communication. They define Technical Communication as a broad field that exhibits particular characteristics:
· Communicating about technical or specialized topics, such as computer applications, medical procedures, or environmental regulations.
· Communicating using technology, such as web pages, help files, or social media sites.
· Providing instructions about how to do something, regardless of how technical the task is or even if technology is used to create or distribute that communication (STC, 2021)
In other words, technical writing makes the information accessible to those who need the information. Imagine putting together an IKEA bed without instructions. Where would you begin? Technical Writing also advances the company’s goals: for you to come back and purchase other products. If you had a bad experience and found yourself without instructions, would you even go back to the store and get more products from them? Probably not.
You have probably written many essays in school, dabbled in creative storytelling, or even wrote a poem. When you enter the job market, these aren’t the types of writing you will encounter or need to produce. Usually, you will be asked to write about how to complete a task, or you will have to read about how a specific software works. These are all examples of Technical Writing. Here are some differences between technical writing and literary writing:
Comparison of Technical and Literary Writing
Technical Writing
Literary Writing
Use of denotative (explicit) language
Vocabulary more focused on subjectivity is mainly reflected in the use of figures of language.
Prevalence serves as a respectful function based on concrete data
Use of the functions: poetic, metalinguistic, and emotional, marked by the subjective spirit of the writer.
Objectivity
Use of subjectivity and with a more personal tone.
Discourse purpose aims to inform and clarify
Objective focused on entertainment.
Fairness and accuracy
Attachment to aesthetic aspects of language. Speech wrapped in a diversity of interpretations.
Precise vocabulary
Gerson (n.d.) presents the continuum of communication from subjective to objective, from literary creative work to technical writing:
Click here for a PDF version of this image. Download Click here for a PDF version of this image.
Gerson, S. M. (n.d.). Writing that Works: A Teacher’s Guide to Technical Writing. Kansas Curriculum Center Washburn University. https://docplayer.net/10370874-Writing-that-works-a-teacher-s-guide-to-technical-writing-by-dr-steven-m-gerson-johnson-county-community-college.htmlLinks to an external site.