44
edits
Technical Writing in the Digital Age: Difference between revisions
Technical Writing in the Digital Age (view source)
Revision as of 14:54, 29 November 2023
, 11 months ago→User Experience
m (I bolded Headings and Subheadings 1 while underlining Subheading 2 to improve the accessibility and scalability of the document.) |
|||
| Line 1: | Line 1: | ||
'''Technical Writing in the Digital Age''' represents the dynamic and evolving discipline of creating written, visual, and interactive materials that convey complex information, instructions, and technical concepts in the context of contemporary digital technologies in a manner that is easily understood by its audience. Its purview encompasses the creation, dissemination, and management of technical documents and content within an expansive digital landscape. Connected networks of workstations, laptops, cell phones, tablets, and servers are the central nervous system in the technical workplace. | <ref></ref>'''Technical Writing in the Digital Age''' represents the dynamic and evolving discipline of creating written, visual, and interactive materials that convey complex information, instructions, and technical concepts in the context of contemporary digital technologies in a manner that is easily understood by its audience. Its purview encompasses the creation, dissemination, and management of technical documents and content within an expansive digital landscape. Connected networks of workstations, laptops, cell phones, tablets, and servers are the central nervous system in the technical workplace. | ||
Major considerations revolve around adapting traditional principles of rhetoric to digital platforms, ensuring effective communication in an era of rapid technological advancements. Key factors include integrating multimedia elements, user-centered design principles, and ethical considerations like accessibility and inclusivity. This discipline also extends to collaborative writing processes and version control systems, acknowledging the necessity of teamwork in producing accurate and up-to-date technical documentation. Multi-modality and the interfacing of multiple media platforms and sources also play a role in digital technical writing. In essence, technical writing in the digital age encapsulates the art and science of conveying technical information in a manner that is comprehensible and accessible to diverse audiences in our digitally driven society. | Major considerations revolve around adapting traditional principles of rhetoric to digital platforms, ensuring effective communication in an era of rapid technological advancements. Key factors include integrating multimedia elements, user-centered design principles, and ethical considerations like accessibility and inclusivity. This discipline also extends to collaborative writing processes and version control systems, acknowledging the necessity of teamwork in producing accurate and up-to-date technical documentation. Multi-modality and the interfacing of multiple media platforms and sources also play a role in digital technical writing. In essence, technical writing in the digital age encapsulates the art and science of conveying technical information in a manner that is comprehensible and accessible to diverse audiences in our digitally driven society. | ||
| Line 283: | Line 283: | ||
*Content hierarchy: Carefully constructing content that is organized for the user and creating a hierarchy of content that prioritizes user needs is necessary to ensure effective user experience and navigation across multiple screen sizes.{{sfn|Robbins|2018|p=499}} | *Content hierarchy: Carefully constructing content that is organized for the user and creating a hierarchy of content that prioritizes user needs is necessary to ensure effective user experience and navigation across multiple screen sizes.{{sfn|Robbins|2018|p=499}} | ||
==='''Multimodality''' === | |||
While responsive design focuses on the system or interface response to user inputs, multimodality refers to the integration of multiple modes of channels of communication to evaluate how effective communication can be in the digital age.<ref>https://grlucas.net/grl/CompFAQ/Digital_Writing/Multimodal_Approach</ref> | |||
==='''Usability'''=== | ==='''Usability'''=== | ||
| Line 290: | Line 293: | ||
A document or website written for usability can be easily scanned by using the following concepts:{{sfn|Garrand|2006|pp=25-26}} | A document or website written for usability can be easily scanned by using the following concepts:{{sfn|Garrand|2006|pp=25-26}} | ||
*Highlighting keywords | *Highlighting keywords | ||
*Writing descriptive headings and subheadings | *Writing descriptive headings and subheadings | ||
*Incorporating bulleted List | *Incorporating bulleted List | ||
*Constructing shorter paragraphs | *Constructing shorter paragraphs | ||
*Implementing an inverted pyramid writing style by beginning with the most important information | *Implementing an inverted pyramid writing style by beginning with the most important information | ||
*Decreasing the word count of traditional writing | *Decreasing the word count of traditional writing | ||
*Using clear and concise language and, when appropriate, visual aids | *Using clear and concise language and, when appropriate, visual aids | ||
| Line 313: | Line 316: | ||
Technical communicators have ethical standards to which they must abide. The standards are divided into three primary categories. They are the employer, the public, and the environment.{{sfn|Markel|2009}} | Technical communicators have ethical standards to which they must abide. The standards are divided into three primary categories. They are the employer, the public, and the environment.{{sfn|Markel|2009}} | ||
==='''The Employer'''=== | === '''The Employer'''=== | ||
Obligations to one's employer include competence and diligence, honesty and candor, confidentiality, and loyalty.{{sfn|Markel|2009}} The technical communicator must adhere to these obligations so that he/she does not harm the reputation or operation of the employer. | Obligations to one's employer include competence and diligence, honesty and candor, confidentiality, and loyalty.{{sfn|Markel|2009}} The technical communicator must adhere to these obligations so that he/she does not harm the reputation or operation of the employer. | ||
Technical communicators may occasionally work for an organization with strict privacy policies that prohibit them from using the documents they create outside of the organization. It is important for ethical communicators to follow the privacy policy for their organization because unauthorized release of information could lead to consequences up to and including termination.{{sfn|Balzotti|2022|p=83}} | Technical communicators may occasionally work for an organization with strict privacy policies that prohibit them from using the documents they create outside of the organization. It is important for ethical communicators to follow the privacy policy for their organization because unauthorized release of information could lead to consequences up to and including termination.{{sfn|Balzotti|2022|p=83}} | ||
=== '''The Public'''=== | ==='''The Public'''=== | ||
Organizations are obligated to treat customers fairly. Technical communicators must convey that the products or services an organization sells are safe and effective.{{sfn|Markel|2009}} | Organizations are obligated to treat customers fairly. Technical communicators must convey that the products or services an organization sells are safe and effective.{{sfn|Markel|2009}} | ||
| Line 324: | Line 327: | ||
Technical communicators have an obligation to the environment. This obligation includes alerting their supervisors, managers, and executive leadership to products or processes that are detrimental to the environment. Protecting the environment can be costly, however, and organizations may consider ignoring legal guidelines to save money.{{sfn|Markel|2009}} Yet, failure to adhere to U.S. Environmental Protection Agency regulations also has financial implications. For example, the penalty for mishandling hazardous waste is five years and/or up to $50,000 for each day of the violation.{{sfn|Environmental Protection Agency|2023}} | Technical communicators have an obligation to the environment. This obligation includes alerting their supervisors, managers, and executive leadership to products or processes that are detrimental to the environment. Protecting the environment can be costly, however, and organizations may consider ignoring legal guidelines to save money.{{sfn|Markel|2009}} Yet, failure to adhere to U.S. Environmental Protection Agency regulations also has financial implications. For example, the penalty for mishandling hazardous waste is five years and/or up to $50,000 for each day of the violation.{{sfn|Environmental Protection Agency|2023}} | ||
=== '''Disinformation''' === | ==='''Disinformation'''=== | ||
One major ethical concern in all forms of writing, but especially in digital writing, is the creation and spread of disinformation. Disinformation, often referred to as "[[w:Fake news|fake news]]," is information that is purposefully spread as false or misleading and is a sub-type of misinformation.{{sfn|Lawrence|2022|loc=section 3.7}} Modern communication technologies allow for the spread of information to occur at a fast pace. Social media is one area where the spread of disinformation occurs regularly. | One major ethical concern in all forms of writing, but especially in digital writing, is the creation and spread of disinformation. Disinformation, often referred to as "[[w:Fake news|fake news]]," is information that is purposefully spread as false or misleading and is a sub-type of misinformation.{{sfn|Lawrence|2022|loc=section 3.7}} Modern communication technologies allow for the spread of information to occur at a fast pace. Social media is one area where the spread of disinformation occurs regularly. | ||
| Line 332: | Line 335: | ||
=='''Pedagogical Approaches'''== | =='''Pedagogical Approaches'''== | ||
==='''Writing Styles'''=== | ==='''Writing Styles''' === | ||
Informal writing, such as some emailing, instant messaging, and texting, has crept into academic writing. In a study conducted by the Pew Internet & America Life Project, almost half of the respondents admitted to omitting proper punctuation and capitalization in their schoolwork. Others even used emoticons. Colleges and universities must now educate students on the different forms of written communication, and when best to employ them.{{sfn|Carroll|2010|p=20}} | Informal writing, such as some emailing, instant messaging, and texting, has crept into academic writing. In a study conducted by the Pew Internet & America Life Project, almost half of the respondents admitted to omitting proper punctuation and capitalization in their schoolwork. Others even used emoticons. Colleges and universities must now educate students on the different forms of written communication, and when best to employ them.{{sfn|Carroll|2010|p=20}} | ||
==='''Multimedia Writing'''=== | ==='''Multimedia Writing''' === | ||
Best practices for tone, grammar, and style can vary depending on the form of media (auditory, visual, print, etc.), and many digital writings will combine two or more of these media formats. Students of technical writing may be taught specific techniques for different types of media in order to become proficient multimedia writers.{{sfn|Garrand|2006|p=23}} | Best practices for tone, grammar, and style can vary depending on the form of media (auditory, visual, print, etc.), and many digital writings will combine two or more of these media formats. Students of technical writing may be taught specific techniques for different types of media in order to become proficient multimedia writers.{{sfn|Garrand|2006|p=23}} | ||
==='''Breaking and Building'''=== | ==='''Breaking and Building''' === | ||
Breaking and building is a method of teaching effective writing that can be applied to technical and digital formats. It asks students to curate collections of digital media by comparing and contrasting ("building"), and also to critically analyze these collections and attempt to reason out the decisions behind them ("breaking").{{sfn|Coco|Torres|2014|p=175}} Each process has a set of targeted learning outcomes. Learning outcomes for "building" include making and reflecting on choices to find, group, present, and compile digital content. Learning outcomes for "breaking" include identifying and critiquing decisions in curating existing digital content, such as where the content originated, how it is grouped, and how it is presented.{{sfn|Coco|Torres|2014|pp=178-179}} | Breaking and building is a method of teaching effective writing that can be applied to technical and digital formats. It asks students to curate collections of digital media by comparing and contrasting ("building"), and also to critically analyze these collections and attempt to reason out the decisions behind them ("breaking").{{sfn|Coco|Torres|2014|p=175}} Each process has a set of targeted learning outcomes. Learning outcomes for "building" include making and reflecting on choices to find, group, present, and compile digital content. Learning outcomes for "breaking" include identifying and critiquing decisions in curating existing digital content, such as where the content originated, how it is grouped, and how it is presented.{{sfn|Coco|Torres|2014|pp=178-179}} | ||
=='''Future Trends and Challenges'''== | =='''Future Trends and Challenges'''== | ||
=== '''Future Trends'''=== | ==='''Future Trends'''=== | ||
Between 2022 and 2032, the [https://en.wikipedia.org/wiki/Bureau_of_Labor_Statistics, United States Bureau of Labor Statistics] is projecting a 7% job growth for technical writers.{{sfn|United States Bureau of Labor Statistics|2023}} To be relevant as a technical writer in the digital age, one must possess the skills of conducting in-depth research, critical thinking, being detail oriented, design, and technical expertise. To succeed at communicating the complex to specific audiences, the technical writer must understand much of the subject in its complexity. This is accomplished through possessing the skills of communication, collaboration, and teamwork.{{sfn|Fechter|2023}} | Between 2022 and 2032, the [https://en.wikipedia.org/wiki/Bureau_of_Labor_Statistics, United States Bureau of Labor Statistics] is projecting a 7% job growth for technical writers.{{sfn|United States Bureau of Labor Statistics|2023}} To be relevant as a technical writer in the digital age, one must possess the skills of conducting in-depth research, critical thinking, being detail oriented, design, and technical expertise. To succeed at communicating the complex to specific audiences, the technical writer must understand much of the subject in its complexity. This is accomplished through possessing the skills of communication, collaboration, and teamwork.{{sfn|Fechter|2023}} | ||
| Line 356: | Line 359: | ||
Because of the ability of chatbots to imitate human-like language, some education administrators have taken precautions to minimize the occurrence of students passing off artificially generated texts as their own. In some instances, educators have taken the view that material drawn from artificial intelligence software must be handled in the same way as sources from human authors.{{sfn|Klein|2023}} In such cases, students who incorporate artificially generated text into their work have been made to denote credit for the artificial intelligence program utilized. | Because of the ability of chatbots to imitate human-like language, some education administrators have taken precautions to minimize the occurrence of students passing off artificially generated texts as their own. In some instances, educators have taken the view that material drawn from artificial intelligence software must be handled in the same way as sources from human authors.{{sfn|Klein|2023}} In such cases, students who incorporate artificially generated text into their work have been made to denote credit for the artificial intelligence program utilized. | ||
==='''Credit''' === | ==='''Credit'''=== | ||
The advent of chatbots has complicated the issue of credit where creative work is concerned. Because chatbots can simulate human speech, their ability to create cinematic dialogues and other types of creative writing have threatened the credits and financial condition of professional writers. According to an article by Aaron Mok and Jacob Zinkula on ''[https://www.businessinsider.com/ Business Insider]'', writing jobs are among the top 10 roles that AI is most likely to replace.{{sfn|Mok|2023}} | The advent of chatbots has complicated the issue of credit where creative work is concerned. Because chatbots can simulate human speech, their ability to create cinematic dialogues and other types of creative writing have threatened the credits and financial condition of professional writers. According to an article by Aaron Mok and Jacob Zinkula on ''[https://www.businessinsider.com/ Business Insider]'', writing jobs are among the top 10 roles that AI is most likely to replace.{{sfn|Mok|2023}} | ||