Writing Process
In the first unit of ENGL 301, we were each tasked with writing three definitions for a technical term relating to our program discipline. We were also asked to provide an introduction to the assignment, which included a scenario describing a situation in which one may provide a definition of the technical term. The term I chose was “cloud architecture”. The “cloud” is a term that is often thrown around in various capacities when discussing modern software. While I originally wanted to write about this term, it is very broad. I decided that “cloud architecture”, which focuses on the specifics of how cloud services are set up, was better suited to this assignment.
With a term in mind, we wrote three separate definitions – a parenthetical definition, a sentence definition, and an expanded definition. A parenthetical definition is one that can be used to briefly explain a term within a sentence. This is typically just a few words. The sentence definition is typically one to two sentences long and provides the writer with an additional opportunity to explain the concepts surrounding the chosen term. The expanded definition is a multi-faceted approach in explaining a term. The writer has the opportunity to write on the operating principle, provide visuals, or even elaborate on the etymology of the term. In my case, for a non-technical audience, I chose to write on the operating principle, display a visual, break down the term into different parts for explanation, and then compare the term with another, more familiar term. I found that it was actually quite difficult to write an expanded definition, as it required a deep understanding of the subject matter – certainly more research was required than expected. I also found the parenthetical definition to be difficult. It required careful word selection to maintain brevity and clarity. Providing an introduction to the assignment was a good exercise as well, to reinforce the fact that the target was a non-technical audience and that there will be cases where these types of definitions are required (especially in cases of client-facing documentation).
Peer Review Process
After writing the three definitions for our chosen term, we were provided with the opportunity to provide a peer review for one of our writing teammates. My teammate’s chosen term was “gingivitis”. While this was a term that I was vaguely familiar with, I did learn quite a bit by reading more into the symptoms of gingivitis, and the etymology of the word. Throughout this portion of the assignment, I learned how to be more methodical in performing a peer review. Dr. Paterson provided guidelines that were very helpful in learning how to properly structure a review of this nature. When conducting peer reviews in the past, I mostly reviewed for grammar and general legibility. Since this was grouped into one section of this peer review, it forced me to think about the remainder of the content more critically. Most importantly, this peer review helped to organize my thoughts around suggestions for improvement in my partner’s work.
Self-Editing / Revision Process
The final portion of the assignment was to perform a self-edit and revision of the original work. Reading comments from my peer review partner, I found it interesting to note the perspective of those outside of the tech field. Having studied and worked in technology for the better part of five years, it is easy to forget that terms which seem commonplace in industry can be completely foreign to those outside the field. For example, in my expanded definition of “cloud architecture”, I had used the terms “end user”, “front end” and “back end”. These had become so embedded in my own vocabulary that I hadn’t realized to a non-technical audience, they required their own explanation. I found that this causes one to think critically about the inclusion of industry jargon when defining other terms – are they required? Do they add anything? Is there an alternative phrasing that could be used? Ultimately it was decided that the terms “front-end” and “back-end” did not add anything to the definition of “cloud architecture” for a non-technical audience, and were therefore removed. The term “end user” was replaced with “software application user” as this was felt to be more descriptive for a broader audience.
Final Thoughts
Overall, I learned quite a bit in completing this assignment. I learned of the different types of definitions that can be required of a technical term, how to effectively write and structure these definitions, and how to properly structure a peer review to provide the most impactful suggestions for improvement. Most importantly, I learned to think more critically about my own writing by considering various perspectives. I’m certainly looking forward to the next assignments in the course as further opportunities to improve my writing!
Enclosed: Revised Definitions Assignment