Jump to content

Technical Writing in the Digital Age: Difference between revisions

no edit summary
m (→‎The Environment: Reviewed for clarity, neutral tone, and grammar)
No edit summary
Line 4: Line 4:


=='''Overview'''==
=='''Overview'''==
=== '''Goal of Technical Communication''' ===
=== '''Goal of Technical Communication''' ===
Technical communication is a discipline utilized by various fields like education, business, and science. In any domain, technical documentation shares a common objective: assisting the audience in achieving a task or goal.{{sfn|Markel|Selber|2019}} This common objective is achieved by the technical writer developing the ability to communicate complex and technical information more easily to the audience.{{sfn|United States Bureau of Labor Statistics|2023}}
Technical communication is a discipline utilized by various fields like education, business, and science. In any domain, technical documentation shares a common objective: assisting the audience in achieving a task or goal.{{sfn|Markel|Selber|2019}} This common objective is achieved by the technical writer developing the ability to communicate complex and technical information more easily to the audience.{{sfn|United States Bureau of Labor Statistics|2023}}
=== '''Characteristics of Technical Communication''' ===
Technical communication is meant to guide an audience and must be easily understood. Successful technical documentation is accurate, logically sound, and appropriate.{{sfn|Perelman|1998}} Communication can be said to be accurate in two different understandings: accurate in description and accurate in content. Accurate descriptions are easy to understand. Accurate content provides for the intended result. Communication delivered logically is well-organized, clear, and will be coherent for most users. Technical information that is appropriate contains elements and steps that are suitable for the intended purpose and audience.


==='''Importance of Research'''===
==='''Importance of Research'''===
Line 21: Line 17:
The ability to adequately, accurately, and completely research a subject prior to writing technical communication dictates the writer's success.
The ability to adequately, accurately, and completely research a subject prior to writing technical communication dictates the writer's success.


=='''Historical Context'''==
=='''History'''==
==='''Technical Writing Profession''' ===
==='''Technical Writing Profession''' ===
Joseph P. Chapline is considered to be one of the first technical writers, having written in 1949 the first-ever user manual for the Binary Automatic Computer (BINAC), an early personal computer.{{sfn|Malone|2008}} In the 1950s, technical writing as a distinct profession began to take shape when technical writers founded formal organizations, academic programs, and conferences dedicated to the art. One of these key writing associations was the Association of Technical Writers and Editors, also formed in the 1950s. Several of these groups eventually merged, forming the Society for Technical Communication in 1960.{{sfn|Malone|2011|pp=285-306}}
Joseph P. Chapline is considered to be one of the first technical writers, having written in 1949 the first-ever user manual for the Binary Automatic Computer (BINAC), an early personal computer.{{sfn|Malone|2008}} In the 1950s, technical writing as a distinct profession began to take shape when technical writers founded formal organizations, academic programs, and conferences dedicated to the art. One of these key writing associations was the Association of Technical Writers and Editors, also formed in the 1950s. Several of these groups eventually merged, forming the Society for Technical Communication in 1960.{{sfn|Malone|2011|pp=285-306}}
Line 31: Line 27:
The projects of today's technical writers can be as varied as writing instructions to assemble a living room chair to creating websites.{{sfn|Grimstead|1999}} The titles of today's technical writers may vary as well. They may be referred to by names as diverse as information architects to documentation specialists.{{sfn|Grimstead|1999}}
The projects of today's technical writers can be as varied as writing instructions to assemble a living room chair to creating websites.{{sfn|Grimstead|1999}} The titles of today's technical writers may vary as well. They may be referred to by names as diverse as information architects to documentation specialists.{{sfn|Grimstead|1999}}


=='''Features of Technical Communication'''==
==='''Future Trends'''===
Technical communication involves conveying complex information to a specific audience. Key features include accuracy, attention to detail, visuals, and clear and concise organization to enhance user understanding.{{sfn|Smirti|2022}}  
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}}


=== '''Accuracy''' ===
=='''Technical Communication Strategies'''==
==='''Characteristics of Technical Communication'''===
Technical communication is meant to guide an audience and must be easily understood. Successful technical documentation is accurate, logically sound, and appropriate.{{sfn|Perelman|1998}} Communication can be said to be accurate in two different understandings: accurate in description and accurate in content. Accurate descriptions are easy to understand. Accurate content provides for the intended result. Communication delivered logically is well-organized, clear, and will be coherent for most users. Technical information that is appropriate contains elements and steps that are suitable for the intended purpose and audience.


==== <u>Standards Compliant</u> ====
==== <u>Standards Compliant</u> ====
Line 47: Line 45:
===== <u>Clear and Concise</u> =====
===== <u>Clear and Concise</u> =====
Technical communication should be logically organized, straightforward, and easily understood by the target audience. The language used should avoid needless jargon and be written in a manner that avoids redundant word usage and excessive explanations.{{sfn|Smirti|2022}}{{sfn|Proofed Editors|2020}}
Technical communication should be logically organized, straightforward, and easily understood by the target audience. The language used should avoid needless jargon and be written in a manner that avoids redundant word usage and excessive explanations.{{sfn|Smirti|2022}}{{sfn|Proofed Editors|2020}}
=== '''Soundness''' ===


==== <u>Formatted and Organized</u> ====
==== <u>Formatted and Organized</u> ====
Line 55: Line 51:
==== <u>Graphical</u> ====
==== <u>Graphical</u> ====
Technical communication utilizes visuals strategically to facilitate understanding of textual content. Visuals such as diagrams, charts, graphs, or images can enhance understanding of a technical document. When presented properly, visuals can explain difficult concepts and make material accessible to a more diverse audience.{{sfn|AI and the LinkedIn Community|2023}}
Technical communication utilizes visuals strategically to facilitate understanding of textual content. Visuals such as diagrams, charts, graphs, or images can enhance understanding of a technical document. When presented properly, visuals can explain difficult concepts and make material accessible to a more diverse audience.{{sfn|AI and the LinkedIn Community|2023}}
=== '''Appropriateness''' ===


==== <u>Audience-specific</u> ====
==== <u>Audience-specific</u> ====
Line 64: Line 58:
The appropriateness of documents requires readers to understand the document's message quickly. The document should be of appropriate style and length for the readers' needs.
The appropriateness of documents requires readers to understand the document's message quickly. The document should be of appropriate style and length for the readers' needs.


=='''Personas in Digital Writing'''==
=== '''Examples of Technical Documents''' ===
Personas in the context of digital writing, which is writing composed, created and read in digital environments, refer to semi-fictional characters that encapsulate the characteristics, behaviors, and needs of target audience segments. They align closely with the principles of user-centered design (UCD).{{sfn|Lucas|2023a}} There are myriad ways to integrate user-centered thinking into the creative process of UX design, and personas are one of the most effective ways to empathize with and analyze users.{{sfn|Goltz|2014}}
 
Personas may guide the creation of documentation and tutorials catering to different user needs. It is crucial to adjust the language and tone to match the persona preference. Different personas can influence and guide the design of the project.
 
Along with adjusting tone and language to suite the desired user, personas also have the responsibility to ensure the purposed digital document properly informs the reader with correct and accurate information the user seeks.
 
=='''Rhetorical Strategies in the Digital Age'''==
[https://en.wikipedia.org/wiki/Rhetoric Rhetoric] is a communication strategy whose primary goal is to persuade an audience. It is grounded in three foundational concepts first defined by the Greek philosopher Aristotle. These concepts are ''logos'', which engages with the reader’s sense of logic or reason; ''pathos'', which appeals to the reader’s emotions; and ''ethos'', which addresses the audience’s values and the writer’s credibility. Within this framework, writers utilize specific techniques or devices to influence and engage readers. Examples include appealing to an audience’s sense of logic by using factual examples to support a point or evoking emotion through descriptive visual language.{{sfn|Gagich|Zickel|n.d.|pp=34-37}}
 
In today’s digital age, writers can use digital technologies as rhetorical devices to influence the reader. Electronic images and informational graphics can be incorporated into digital and online documents to illustrate or reinforce points made in the text.{{sfn|Markel|Selber|2019}} [[#Hyperlinking|Hyperlinks]] can provide access to additional information that supports authors’ ideas and enhances their credibility.{{sfn|Lucas|2023g|}} Nevertheless, the writer's basic task of informing and persuading an audience is the same in digital communication as in other forms of writing.{{sfn|DeVoss|National Writing Project|Eidman-Aadahl|Hicks|2010|p=105}}
 
Digital writers must therefore consider specific elements that compose the rhetorical context in which texts are created and delivered. Such elements may include evaluating the demographics, habits, and needs of an intended audience; determining the overall objective of the communications; and deciding what technologies will be used to create the content. Together, this analysis allows writers to craft messages that both appeal to and inform the target audience. In the digital age, such rhetorical messages may be conveyed through websites, social media, and other digital platforms.{{sfn|Lawrence|2022|pp=6-14}}
 
=='''Tools for Digital Technology'''==
With the rise of digital technology, technical writing has had to adapt to the needs of a digital era. The predominant impact of such a revolution was that it made technical communication more accessible by increasing the breadth of its viewers. The World Wide Web is public and can be accessed by anyone with access to the Internet. Such a phenomenon can be exploited to increase the audience of a virtual document. {{Citation needed}}
 
Technical writers can use various tools to author and present their documents.
 
=== '''Content Management Systems (CMS)''' ===
A content management system (CMS) is a software application that allows users to create, manage, and modify digital content on a website. It provides a user-friendly interface and tools to easily organize, publish, and update content, including text, images, videos, and documents. Additionally, CMSs often offer features like user permissions, version control, and Search Engine Optimization (SEO) to enhance the overall website management experience.{{sfn|Carroll|2006|p=129}} Some popular examples of CMS include [https://wordpress.com/ WordPress], [https://www.wix.com/ Wix], and [https://www.blogger.com/about/?bpli=1 Blogger].
 
=== '''Image Processing Software''' ===
Image processing software plays a valuable role in technical and digital writing by facilitating the creation and enhancement of visuals. Documentation and tutorials help optimize images to convey processes or procedures effectively. Whether for screen captures illustrating software interfaces, data visualizations, or graphics for digital content, image processing tools contribute to creating clear and visually appealing materials.{{sfn|Robbins|2018|p=664}} These tools, such as [https://www.adobe.com/ Adobe] and [https://www.canva.com/ Canva], enhance the visual impact of technical and digital writing, ensuring that images are optimized, informative, and engaging for the audience.
 
=== '''Word Processors''' ===
Word processors are software applications designed for creating, editing, and formatting documents on a computer. They provide many features, such as spell-checking, grammar-checking, and inserting images and tables. These programs are typically used for writing essays, creating reports, or drafting professional documents.{{sfn|Carroll|2010|p=229}} Some popular software applications are [https://www.microsoft.com/en-us/microsoft-365/word Microsoft Word], [https://www.google.com/docs/about/ Google Docs][https://www.microsoft.com/en-us/microsoft-365/sharepoint/collaboration , SharePoint], and [https://www.apple.com/pages/ Apple Pages]. These programs allow documents to be readily disseminated. Comment capability enables audience members to interact about a document with one another and the author.
 
=== '''Text Editors''' ===
Text editors are fundamental technical and digital writing tools, offering a platform for creating and manipulating plain text files. They are indispensable for programming tasks, providing syntax highlighting and code folding features. Text editors are commonly used to write code, markup languages (HTML, XML, Markdown), and edit configuration files.{{sfn|Godson|p=37-41}} Notable examples include [https://apps.microsoft.com/detail/windows-notepad/9MSMLRH6LZF3?hl=en-US&gl=US Notepad] (Windows), [https://support.apple.com/guide/textedit/welcome/mac TextEdit] (macOS), and [https://notepad-plus-plus.org/ Notepad++]. Whether for programmers, writers, or system administrators, text editors play a crucial role in content creation and technical work.
 
== '''Technical Documents''' ==
Technical writing encompasses various genres and styles, influenced by the information and discourse communities. Not all technical documents are produced by technical writers, as professionals produce various technical documents.{{sfn|Lannon|Gurak|2020|p=32}}  
Technical writing encompasses various genres and styles, influenced by the information and discourse communities. Not all technical documents are produced by technical writers, as professionals produce various technical documents.{{sfn|Lannon|Gurak|2020|p=32}}  


Common types of technical communication include:{{sfn|Mussack|2021}}
Common types of technical communication include:{{sfn|Mussack|2021}}


=== '''Case Studies''' ===
==== '''Case Studies''' ====
Case studies are a form of empirical or observational research that consists of in-depth examination of distinct individuals, groups, events, or scenarios. This research can be used to generate qualitative or quantitative data.{{sfn|Johnson-Sheehan|2018|pp=401-404}}
Case studies are a form of empirical or observational research that consists of in-depth examination of distinct individuals, groups, events, or scenarios. This research can be used to generate qualitative or quantitative data.{{sfn|Johnson-Sheehan|2018|pp=401-404}}


=== '''Data Sheets''' ===
==== '''Data Sheets''' ====
A data sheet, also known as a technical datasheet, is a document used to describe and summarize the characteristics of a product, material, component, or technology.{{sfn|IDA|2020|p=}}
A data sheet, also known as a technical datasheet, is a document used to describe and summarize the characteristics of a product, material, component, or technology.{{sfn|IDA|2020|p=}}


=== '''Descriptions''' ===
==== '''Descriptions''' ====
Descriptions are concise explanations of procedures and processes that assist readers in understanding how something works. Product descriptions and process descriptions are the two main types of technical descriptions.{{sfn|Lannon|Gurak|2020|pp=443-453}}
Descriptions are concise explanations of procedures and processes that assist readers in understanding how something works. Product descriptions and process descriptions are the two main types of technical descriptions.{{sfn|Lannon|Gurak|2020|pp=443-453}}


Line 112: Line 75:
*Process: provides step-by-step instructions on how to perform a particular task or achieve a specific outcome.
*Process: provides step-by-step instructions on how to perform a particular task or achieve a specific outcome.


=== '''Documentation''' ===
==== '''Documentation''' ====
Documentation comprises various texts that allow users to accomplish tasks or gain information. It generally falls into three categories, which can be defined as follows:
Documentation comprises various texts that allow users to accomplish tasks or gain information. It generally falls into three categories, which can be defined as follows:
* Instructions: Text that describes how to complete a task, often offering numbered steps. Examples include how to download software or assemble a product.{{sfn|Balzotti|2022|p=167}}
* Instructions: Text that describes how to complete a task, often offering numbered steps. Examples include how to download software or assemble a product.{{sfn|Balzotti|2022|p=167}}
Line 118: Line 81:
* Procedures and Protocols: Guidelines to ensure consistency, quality, and safety in the workplace. For example, a hospital may provide staff with procedures on how to adapt operations during an emergency, such as a power outage.{{sfn|Johnson-Sheehan|2018|p=205}}
* Procedures and Protocols: Guidelines to ensure consistency, quality, and safety in the workplace. For example, a hospital may provide staff with procedures on how to adapt operations during an emergency, such as a power outage.{{sfn|Johnson-Sheehan|2018|p=205}}


=== '''Email''' ===
==== '''Email''' ====
Emails are the primary form of communication in the workplace, used for both internal and external communication. They facilitate information exchange, idea exchange, and activity coordination.{{sfn|Lannon|Gurak|2020|p=335}} Emails should be brief, concise, readable, and targeted to specific audiences with specific subject lines.{{sfn|Lannon|Gurak|2020|p=348}}
Emails are the primary form of communication in the workplace, used for both internal and external communication. They facilitate information exchange, idea exchange, and activity coordination.{{sfn|Lannon|Gurak|2020|p=335}} Emails should be brief, concise, readable, and targeted to specific audiences with specific subject lines.{{sfn|Lannon|Gurak|2020|p=348}}


=== '''Letters''' ===
==== '''Letters''' ====
Letters are a traditional form of communication most often used by employees to communicate with individuals outside of a company or organization. They are typically written on company letterhead. Today, letters are sent either by U.S. mail or electronically.{{sfn|Johnson-Sheehan|2018|p=139}}
Letters are a traditional form of communication most often used by employees to communicate with individuals outside of a company or organization. They are typically written on company letterhead. Today, letters are sent either by U.S. mail or electronically.{{sfn|Johnson-Sheehan|2018|p=139}}


=== '''Memos''' ===
==== '''Memos''' ====
A memo (short for memorandum) is an official communication, usually a message from the company, a manager or director, or another person or group acting in an official capacity, used to communicate with others within the same organization.{{sfn|Lannon|Gurak|2020|p=353}}
A memo (short for memorandum) is an official communication, usually a message from the company, a manager or director, or another person or group acting in an official capacity, used to communicate with others within the same organization.{{sfn|Lannon|Gurak|2020|p=353}}


=== '''Press Releases''' ===
==== '''Press Releases''' ====
A press release can be an announcement or recent news that is distributed to media outlets from a company, with intentions on spreading the information to the general public. A press release can be called a press-statement, news release or media release.{{sfn|Pradhan|2021}}
A press release can be an announcement or recent news that is distributed to media outlets from a company, with intentions on spreading the information to the general public. A press release can be called a press-statement, news release or media release.{{sfn|Pradhan|2021}}


=== '''Proposals''' ===
==== '''Proposals''' ====
A proposal is a document that identifies an existing problem or opportunity and outlines a comprehensive strategy for addressing it. Organizations create ''internal'' proposals to describe programs and projects that meet specific operational needs, such as a plan to replace an outdated software system. Companies develop ''external'' proposals for potential customers or clients. These documents detail new products, services, or initiatives that a company will implement to address a specific customer concern.{{sfn|Johnson-Sheehan|2018|p=245}}
A proposal is a document that identifies an existing problem or opportunity and outlines a comprehensive strategy for addressing it. Organizations create ''internal'' proposals to describe programs and projects that meet specific operational needs, such as a plan to replace an outdated software system. Companies develop ''external'' proposals for potential customers or clients. These documents detail new products, services, or initiatives that a company will implement to address a specific customer concern.{{sfn|Johnson-Sheehan|2018|p=245}}


=== '''Reports''' ===
==== '''Reports''' ====
A report is a concise, easily understandable document that presents technical information in a clear, organized format, allowing readers to access varying levels of information. Reports are categorized as informal, such as briefs, and formal, such as research, scientific, and completion reports.{{sfn|Johnson-Sheehan|2018|loc=chpt 10 & 11}}
A report is a concise, easily understandable document that presents technical information in a clear, organized format, allowing readers to access varying levels of information. Reports are categorized as informal, such as briefs, and formal, such as research, scientific, and completion reports.{{sfn|Johnson-Sheehan|2018|loc=chpt 10 & 11}}


==== <u>Informal or Brief Reports</u> ====
===== <u>Informal or Brief Reports</u> =====
Informal or brief reports provide an objective overview of an organization's current state, past events, and future plans, ensuring that readers are well-informed about the organization's operations. Some examples include{{sfn|Johnson-Sheehan|2018|pp=285-288}}:
Informal or brief reports provide an objective overview of an organization's current state, past events, and future plans, ensuring that readers are well-informed about the organization's operations. Some examples include{{sfn|Johnson-Sheehan|2018|pp=285-288}}:


Line 144: Line 107:
* Laboratory Reports describe experiments, tests, or inspections.
* Laboratory Reports describe experiments, tests, or inspections.


==== <u>Formal Reports</u> ====
===== <u>Formal Reports</u> =====
A formal report is a factual and data-driven response to a research question.
A formal report is a factual and data-driven response to a research question.
* Research reports present the findings of a study.  
* Research reports present the findings of a study.  
Line 150: Line 113:
* Completion reports assess the outcomes of a project or initiative and provide feedback to management or the client.
* Completion reports assess the outcomes of a project or initiative and provide feedback to management or the client.


=== '''Resumes''' ===
==== '''Resumes''' ====
Resumes offer an overview of an individual’s educational credentials and professional experience and often are used to demonstrate an applicant’s qualifications to potential employers.{{sfn|Johnson-Sheehan|2018|p=100}} They may be organized in various ways, but two common approaches are chronologically and by skills.  
Resumes offer an overview of an individual’s educational credentials and professional experience and often are used to demonstrate an applicant’s qualifications to potential employers.{{sfn|Johnson-Sheehan|2018|p=100}} They may be organized in various ways, but two common approaches are chronologically and by skills.  


Line 157: Line 120:
Skills resumes provide employment history, but the primary focus is to highlight how an individual applied distinct skills and experiences across various professional positions.{{sfn|Markel|Selber|2019|pp=411-412}}
Skills resumes provide employment history, but the primary focus is to highlight how an individual applied distinct skills and experiences across various professional positions.{{sfn|Markel|Selber|2019|pp=411-412}}


=== '''User guides''' ===
==== '''User guides''' ====
A user guide is an instructional manual created to help consumers use the product, service or system. A user guide typically includes step-by-step instructions.{{Sfn|Wainaina|2022}}
A user guide is an instructional manual created to help consumers use the product, service or system. A user guide typically includes step-by-step instructions.{{Sfn|Wainaina|2022}}


=='''Search Engine Optimization (SEO)'''==
=='''Digital Writing Strategies'''==
SEO refers to the practice of optimizing online content to enhance its visibility and ranking on search engine results pages (SERPs), making it a crucial skill for digital writers.{{sfn|Lucas|2023b}} To optimize content for SEO means to have the goal of SEO in mind at the time of designing, creating, and writing a web page for publication. Using keywords and alt-text are two examples of optimizing content for SEO.{{sfn|Barr|2010|loc=chpt. 17}}
 
==='''Keywords'''===
Keywords are the words that search engines crawl a website for and index as the page's most important words. Based on other pages using the same keywords, the website is added into the search engine results pages from best matches to worst matches. The position of a website in search results is influenced by where it ranks on a scale determined by the keywords that a user searches for.{{sfn|Lucas|2023b}} To optimize a website's keywords, you should begin with researching keywords on your own website and ensure that you have an XML [https://en.wikipedia.org/wiki/Sitemaps sitemap] so search engines such as [https://en.wikipedia.org/wiki/Google Google] can crawl your web pages for updated information. In addition to using keywords, updating a page's metadata information can also help with showing up on SERPs. Using title and header tags as well as meta descriptions for content also helps optimize a website's ratings in SERPs.{{sfn|Lucas|2023b}}
 
==='''Alt-Text'''===
Alt-Text (alternative text), or [https://en.wikipedia.org/wiki/Alt_attribute Alt Attributes], is a practice that increases the usability and accessibility of a web page for users. Alt-Text is often used for visual elements that cannot be displayed in a different format but still provides description of the element for screen readers or users that may have a disability. Alt-Text also improves a website's SEO as a form of content optimization.{{sfn|Lucas|2023b}}
 
==='''Social Media Presence'''===
Sharing content from a website across different social media platforms is another way to create SEO optimization. This technique can help with being seen as legitimate and improves visibility of the website overall. Additionally, it can drive traffic and enables back-linking to occur when other websites have the ability to also link to the website.{{sfn|Lucas|2023b}}
 
=== '''Goals of Searching: The User's Perspective'''===
A user of search engines formulates queries by using keywords or posing questions. One of the most important elements of building an SEO strategy for a website is developing a thorough understanding of the psychology of your target audience and how they use words and concepts to obtain information about the services and/or products you provide. Once you understand how the average search engine user—and, more specifically, your target audience—utilizes query-based search engines, you can more effectively reach and keep those users.{{sfn|Enge|Spencer|Stricchiola|2022|p=9}}
 
=='''Digital Documentation''' ==
Digital documentation is the conversion of physical documents into digital files, enabling easier access, retrieval, and sharing of information. It includes features like searchability, version control, and security measures to ensure data integrity and confidentiality.{{sfn|Lucas|2023c}}


==='''Characteristics of Digital Documents'''===
==='''Characteristics of Digital Documents'''===
Line 228: Line 175:
Digital documents can be subjected to data analytics techniques, allowing organizations to extract valuable insights from large volumes of textual data, which can inform decision-making and strategy.{{sfn|Lucas|2023c}}
Digital documents can be subjected to data analytics techniques, allowing organizations to extract valuable insights from large volumes of textual data, which can inform decision-making and strategy.{{sfn|Lucas|2023c}}


=='''Examples of Digital Documents'''==
==='''Examples of Digital Documents'''===
In technical and professional writing, digital documentation takes various forms. These methods streamline the sharing of technical information, enhance collaboration, and ensure easy accessibility within professional settings, contributing to efficient communication and knowledge dissemination.{{Citation needed}}
Digital documentation is the conversion of physical documents into digital files, enabling easier access, retrieval, and sharing of information. It includes features like searchability, version control, and security measures to ensure data integrity and confidentiality.{{sfn|Lucas|2023c}} In technical and professional writing, digital documentation takes various forms. These methods streamline the sharing of technical information, enhance collaboration, and ensure easy accessibility within professional settings, contributing to efficient communication and knowledge dissemination.{{Citation needed}}


=== '''Infographics''' ===
==== '''Infographics''' ====
Infographics, shared as digital documents, typically combine text, graphics, and illustrations to convey complex concepts or data in a concise and visually appealing format. Infographics are often used to simplify information, making it more accessible to a broader audience, and are found in presentations, reports, websites, and educational materials.{{sfn|Lannon|Gurak|2020|pp=292-293}}
Infographics, shared as digital documents, typically combine text, graphics, and illustrations to convey complex concepts or data in a concise and visually appealing format. Infographics are often used to simplify information, making it more accessible to a broader audience, and are found in presentations, reports, websites, and educational materials.{{sfn|Lannon|Gurak|2020|pp=292-293}}


=== '''Presentations''' ===
==== '''Presentations''' ====
Presentations created with [https://en.wikipedia.org/wiki/Microsoft_PowerPoint PowerPoint] or [https://en.wikipedia.org/wiki/Google_Slides Google Slides] are vital for professional communication and knowledge sharing. They condense complex information into visually appealing slides for effective presentations by using photos, videos, graphics, charts, and graphs.{{sfn|Parkinson|2018|loc=chpt. 4}}
Presentations created with [https://en.wikipedia.org/wiki/Microsoft_PowerPoint PowerPoint] or [https://en.wikipedia.org/wiki/Google_Slides Google Slides] are vital for professional communication and knowledge sharing. They condense complex information into visually appealing slides for effective presentations by using photos, videos, graphics, charts, and graphs.{{sfn|Parkinson|2018|loc=chpt. 4}}


=== '''Blogs''' ===
==== '''Blogs''' ====
A blog, short for "weblog," is an informational website organized into short articles called posts, typically chronologically ordered series of website updates, written and organized similar to a traditional diary.{{sfn|Bair|2014|p=7}} They are regularly updated, providing readers with insights on a specific topic or subject. Blogs serve various purposes, including sharing opinions, providing news, offering educational content, and documenting personal experiences.{{sfn|Rose|Garret|2012|p=2}}
A blog, short for "weblog," is an informational website organized into short articles called posts, typically chronologically ordered series of website updates, written and organized similar to a traditional diary.{{sfn|Bair|2014|p=7}} They are regularly updated, providing readers with insights on a specific topic or subject. Blogs serve various purposes, including sharing opinions, providing news, offering educational content, and documenting personal experiences.{{sfn|Rose|Garret|2012|p=2}}


=== '''Forums''' ===
==== '''Forums''' ====
Forums are an example of a digital document that allows users to seek and provide information within a community. Forums are gathering information points users provide instead of technical writers. Companies can utilize forums as part of their technical communication with consumers in the digital environment, expanding past the traditional technical communication of a user manual.{{sfn|Ellingson, Marissa|2014}}
Forums are an example of a digital document that allows users to seek and provide information within a community. Forums are gathering information points users provide instead of technical writers. Companies can utilize forums as part of their technical communication with consumers in the digital environment, expanding past the traditional technical communication of a user manual.{{sfn|Ellingson, Marissa|2014}}


=='''User Experience'''==
==='''Personas in Digital Writing'''===
Personas in the context of digital writing, which is writing composed, created and read in digital environments, refer to semi-fictional characters that encapsulate the characteristics, behaviors, and needs of target audience segments. They align closely with the principles of user-centered design (UCD).{{sfn|Lucas|2023a}} There are myriad ways to integrate user-centered thinking into the creative process of UX design, and personas are one of the most effective ways to empathize with and analyze users.{{sfn|Goltz|2014}}
 
Personas may guide the creation of documentation and tutorials catering to different user needs. It is crucial to adjust the language and tone to match the persona preference. Different personas can influence and guide the design of the project.
 
Along with adjusting tone and language to suite the desired user, personas also have the responsibility to ensure the purposed digital document properly informs the reader with correct and accurate information the user seeks.
 
==='''Rhetoric'''===
[https://en.wikipedia.org/wiki/Rhetoric Rhetoric] is a communication strategy whose primary goal is to persuade an audience. It is grounded in three foundational concepts first defined by the Greek philosopher Aristotle. These concepts are ''logos'', which engages with the reader’s sense of logic or reason; ''pathos'', which appeals to the reader’s emotions; and ''ethos'', which addresses the audience’s values and the writer’s credibility. Within this framework, writers utilize specific techniques or devices to influence and engage readers. Examples include appealing to an audience’s sense of logic by using factual examples to support a point or evoking emotion through descriptive visual language.{{sfn|Gagich|Zickel|n.d.|pp=34-37}}
 
In today’s digital age, writers can use digital technologies as rhetorical devices to influence the reader. Electronic images and informational graphics can be incorporated into digital and online documents to illustrate or reinforce points made in the text.{{sfn|Markel|Selber|2019}} [[#Hyperlinking|Hyperlinks]] can provide access to additional information that supports authors’ ideas and enhances their credibility.{{sfn|Lucas|2023g|}} Nevertheless, the writer's basic task of informing and persuading an audience is the same in digital communication as in other forms of writing.{{sfn|DeVoss|National Writing Project|Eidman-Aadahl|Hicks|2010|p=105}}
 
Digital writers must therefore consider specific elements that compose the rhetorical context in which texts are created and delivered. Such elements may include evaluating the demographics, habits, and needs of an intended audience; determining the overall objective of the communications; and deciding what technologies will be used to create the content. Together, this analysis allows writers to craft messages that both appeal to and inform the target audience. In the digital age, such rhetorical messages may be conveyed through websites, social media, and other digital platforms.{{sfn|Lawrence|2022|pp=6-14}}
 
==='''Tools for Digital Technology'''===
With the rise of digital technology, technical writing has had to adapt to the needs of a digital era. The predominant impact of such a revolution was that it made technical communication more accessible by increasing the breadth of its viewers. The World Wide Web is public and can be accessed by anyone with access to the Internet. Such a phenomenon can be exploited to increase the audience of a virtual document. {{Citation needed}}
 
Technical writers can use various tools to author and present their documents.
 
==== '''Content Management Systems (CMS)''' ====
A content management system (CMS) is a software application that allows users to create, manage, and modify digital content on a website. It provides a user-friendly interface and tools to easily organize, publish, and update content, including text, images, videos, and documents. Additionally, CMSs often offer features like user permissions, version control, and Search Engine Optimization (SEO) to enhance the overall website management experience.{{sfn|Carroll|2006|p=129}} Some popular examples of CMS include [https://wordpress.com/ WordPress], [https://www.wix.com/ Wix], and [https://www.blogger.com/about/?bpli=1 Blogger].
 
==== '''Image Processing Software''' ====
Image processing software plays a valuable role in technical and digital writing by facilitating the creation and enhancement of visuals. Documentation and tutorials help optimize images to convey processes or procedures effectively. Whether for screen captures illustrating software interfaces, data visualizations, or graphics for digital content, image processing tools contribute to creating clear and visually appealing materials.{{sfn|Robbins|2018|p=664}} These tools, such as [https://www.adobe.com/ Adobe] and [https://www.canva.com/ Canva], enhance the visual impact of technical and digital writing, ensuring that images are optimized, informative, and engaging for the audience.
 
==== '''Word Processors''' ====
Word processors are software applications designed for creating, editing, and formatting documents on a computer. They provide many features, such as spell-checking, grammar-checking, and inserting images and tables. These programs are typically used for writing essays, creating reports, or drafting professional documents.{{sfn|Carroll|2010|p=229}} Some popular software applications are [https://www.microsoft.com/en-us/microsoft-365/word Microsoft Word], [https://www.google.com/docs/about/ Google Docs][https://www.microsoft.com/en-us/microsoft-365/sharepoint/collaboration , SharePoint], and [https://www.apple.com/pages/ Apple Pages]. These programs allow documents to be readily disseminated. Comment capability enables audience members to interact about a document with one another and the author.
 
==== '''Text Editors''' ====
Text editors are fundamental technical and digital writing tools, offering a platform for creating and manipulating plain text files. They are indispensable for programming tasks, providing syntax highlighting and code folding features. Text editors are commonly used to write code, markup languages (HTML, XML, Markdown), and edit configuration files.{{sfn|Godson|p=37-41}} Notable examples include [https://apps.microsoft.com/detail/windows-notepad/9MSMLRH6LZF3?hl=en-US&gl=US Notepad] (Windows), [https://support.apple.com/guide/textedit/welcome/mac TextEdit] (macOS), and [https://notepad-plus-plus.org/ Notepad++]. Whether for programmers, writers, or system administrators, text editors play a crucial role in content creation and technical work.
 
==='''Search Engine Optimization (SEO)'''===
SEO refers to the practice of optimizing online content to enhance its visibility and ranking on search engine results pages (SERPs), making it a crucial skill for digital writers.{{sfn|Lucas|2023b}} To optimize content for SEO means to have the goal of SEO in mind at the time of designing, creating, and writing a web page for publication. Using keywords and alt-text are two examples of optimizing content for SEO.{{sfn|Barr|2010|loc=chpt. 17}}
 
===='''Keywords'''====
Keywords are the words that search engines crawl a website for and index as the page's most important words. Based on other pages using the same keywords, the website is added into the search engine results pages from best matches to worst matches. The position of a website in search results is influenced by where it ranks on a scale determined by the keywords that a user searches for.{{sfn|Lucas|2023b}} To optimize a website's keywords, you should begin with researching keywords on your own website and ensure that you have an XML [https://en.wikipedia.org/wiki/Sitemaps sitemap] so search engines such as [https://en.wikipedia.org/wiki/Google Google] can crawl your web pages for updated information. In addition to using keywords, updating a page's metadata information can also help with showing up on SERPs. Using title and header tags as well as meta descriptions for content also helps optimize a website's ratings in SERPs.{{sfn|Lucas|2023b}}
 
===='''Alt-Text'''====
Alt-Text (alternative text), or [https://en.wikipedia.org/wiki/Alt_attribute Alt Attributes], is a practice that increases the usability and accessibility of a web page for users. Alt-Text is often used for visual elements that cannot be displayed in a different format but still provides description of the element for screen readers or users that may have a disability. Alt-Text also improves a website's SEO as a form of content optimization.{{sfn|Lucas|2023b}}
 
===='''Social Media Presence'''====
Sharing content from a website across different social media platforms is another way to create SEO optimization. This technique can help with being seen as legitimate and improves visibility of the website overall. Additionally, it can drive traffic and enables back-linking to occur when other websites have the ability to also link to the website.{{sfn|Lucas|2023b}}
 
==== '''Goals of Searching: The User's Perspective'''====
A user of search engines formulates queries by using keywords or posing questions. One of the most important elements of building an SEO strategy for a website is developing a thorough understanding of the psychology of your target audience and how they use words and concepts to obtain information about the services and/or products you provide. Once you understand how the average search engine user—and, more specifically, your target audience—utilizes query-based search engines, you can more effectively reach and keep those users.{{sfn|Enge|Spencer|Stricchiola|2022|p=9}}
 
==='''User Experience'''===
User experience (UX) is how a product works and is experienced from the user's perspective. By creating a positive user experience, technical writers can ensure the intended message is effectively communicated and retained. Digital documents can be created with efficient user experiences by practicing several design methods, including information architecture, responsive design, usability, and user-centered design. {{Citation needed}}  
User experience (UX) is how a product works and is experienced from the user's perspective. By creating a positive user experience, technical writers can ensure the intended message is effectively communicated and retained. Digital documents can be created with efficient user experiences by practicing several design methods, including information architecture, responsive design, usability, and user-centered design. {{Citation needed}}  


==='''User-Centered Design'''===
===='''User-Centered Design'''====
User-centered design (UCD) is implemented by considering the user and their needs throughout the entire development of a product.{{sfn|Garrett|2011|p=17}} The approach of UCD in technical writing consists of the following methodologies:{{sfn|Lucas|2023e}}
User-centered design (UCD) is implemented by considering the user and their needs throughout the entire development of a product.{{sfn|Garrett|2011|p=17}} The approach of UCD in technical writing consists of the following methodologies:{{sfn|Lucas|2023e}}


Line 256: Line 249:
* Maintenance and updates: to maintain a digital document based on user feedback and changing needs
* Maintenance and updates: to maintain a digital document based on user feedback and changing needs


==='''Information Architecture'''===  
===='''Information Architecture'''====


To ensure a digital document has effective UX design and accessible information, technical writers must construct a clear and organized information architecture (IA). IA is a design principle that organizes information so that it is easily found and understood by users, prioritizing their needs and reducing information overload. A design challenge is making IA understood across multiple digital experiences, changing the navigation structure to fit different media while staying logical and consistent for the user.{{sfn|Rosenfeld|Morville|Arango|2006|pp=1, 17-18}} IA that is not constructed well can confuse the user and could cause them to give up their search of information in frustration.{{sfn|Garrand|2006|p=12}}   
To ensure a digital document has effective UX design and accessible information, technical writers must construct a clear and organized information architecture (IA). IA is a design principle that organizes information so that it is easily found and understood by users, prioritizing their needs and reducing information overload. A design challenge is making IA understood across multiple digital experiences, changing the navigation structure to fit different media while staying logical and consistent for the user.{{sfn|Rosenfeld|Morville|Arango|2006|pp=1, 17-18}} IA that is not constructed well can confuse the user and could cause them to give up their search of information in frustration.{{sfn|Garrand|2006|p=12}}   
Line 270: Line 263:
*Searching systems: how users search for specific information
*Searching systems: how users search for specific information


=== '''Responsive Design''' ===  
==== '''Responsive Design''' ====


Responsive design is a strategy that appropriately updates the layout and content of a website or document in relation to the screen size, device, and orientation, allowing the site or document to be easily viewed and navigated regardless of the device used. With the increased use of mobile devices, web content should be constructed with proper responsive web design (RWD) to ensure effective UX and usability on those devices.{{sfn|Robbins|2018|p=485}}   
Responsive design is a strategy that appropriately updates the layout and content of a website or document in relation to the screen size, device, and/or orientation, allowing the site or document to be easily viewed and navigated regardless of device used. With the increased use of mobile devices, web content should be constructed with proper responsive web design (RWD) to ensure effective UX and usability on those devices.{{sfn|Robbins|2018|p=485}}   


There are several design strategies that can be implemented that will increase the success of RWD:{{sfn|Robbins|2018|p=487}}   
There are several design strategies that can be implemented that will increase the success of RWD:{{sfn|Robbins|2018|p=487}}   
Line 278: Line 271:
*Fluid layout: Responsive sites can be constructed using a fluid layout (or flexible grid) system that will allow content to adjust and flow according to the available screen space.
*Fluid layout: Responsive sites can be constructed using a fluid layout (or flexible grid) system that will allow content to adjust and flow according to the available screen space.


*Flexible and responsive images: Images and other embedded media can be instructed to fit their containers instead of remaining at a fixed size. Images with varying resolutions can also be swapped according to screen size to avoid high-resolution images on smaller devices.
*Flexible and responsive images: Images and other embedded media can be instructed so that they fit their containers instead of remaining at a fixed size. Images with varying resolutions can also be swapped according to screen size to avoid high-resolution images on smaller devices.  


*CSS media queries: Media queries can be written into the CSS (Cascading Style Sheet), instructing the site's construction according to screen width and orientation. Adding breakpoints for several screen sizes allows pages to be designed for specific devices.
*CSS media queries: Media queries can be written into the CSS (Cascading Style Sheet), which would instruct the construction of the site according to screen width and orientation. Adding breakpoints for several screen sizes allows pages to be designed for specific devices.


*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''' ===
===='''Multimodality''' ====
While responsive design focuses on the system or interface response to user inputs, multimodality refers to integrating multiple modes of communication to evaluate how effective communication can be in the digital age..<ref>Lucas, Gerald (2023). [[grl:CompFAQ/Digital_Writing/Multimodal_Approach|"Multimodal Approaches in Technical Writing"]]. grlucas.net. MediaWiki. Retrieved 2023-11-29. </ref>
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>Lucas, Gerald (2023). [[grl:CompFAQ/Digital_Writing/Multimodal_Approach|"Multimodal Approaches in Technical Writing"]]. grlucas.net. MediaWiki. Retrieved 2023-11-29. </ref>


==='''Usability'''===  
===='''Usability'''====


Technical writers must create documents and websites that meet the expectations of their readers and users. In doing so, writers increase the usability of their site or document.{{sfn|Garrand|2006|p=26}} Usability consultant Steve Krug considers the most important rule for ensuring a site or document is usable is by making pages self-evident and allowing the user not to have to think about actions.{{sfn|Krug|2014|pp=11-18 }} A website that is well designed for usability means that the users will not have any questions about the content or functions of the site. The site will have a clear hierarchy, use standard web design principles, have well-defined content areas, include noticeable and simple links, and have limited distractions.{{sfn|Carroll|2010|p=69}}  
Technical writers must create documents and websites that meet the expectations of their readers and users, and in doing so, writers increase the usability of their site or document.{{sfn|Garrand|2006|p=26}} Usability consultant Steve Krug considers the most important rule for ensuring a site or document is usable is by making pages self-evident and allowing the user not to have to think about actions.{{sfn|Krug|2014|pp=11-18 }} A website that is well designed for usability means that the users will not have any questions about the content or functions of the site. The site will have a clear hierarchy, use standard web design principles, have well-defined content areas, include noticeable and simple links, and will have limited distractions.{{sfn|Carroll|2010|p=69}}  


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}}  
Line 306: Line 299:


*Using clear and concise language and, when appropriate, visual aids
*Using clear and concise language and, when appropriate, visual aids
=='''Ethical Considerations'''==
In technical workplaces, resolving ethical dilemmas will be part of one's job. Resources, time, and reputations are at stake, so one will feel pressure to overpromise, underdeliver, bend the rules, cook the numbers, or exaggerate results. Technical fields are also highly competitive, so people sometimes stretch a little further than they should. Ethical dilemmas can force one into situations in which all choices seem unsatisfactory.{{sfn|Johnson-Sheehan|2018|pp=71-84}}
The Society for Technical Communication (STC) is the world's oldest professional association dedicated to advancing the field of technical communication.{{sfn|Society for Technical Communication|2023a}} The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.{{sfn|Society for Technical Communication|2023b}}
Technical communicators also have to be careful to avoid plagiarism, or taking ideas, thoughts, or words from someone else and passing them off as one's own.{{sfn|Carroll|2010|p=280}}
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'''===
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 as not to harm the employer's reputation or operation.
Technical communicators may occasionally work for an organization with strict privacy policies prohibiting them from using the documents they create outside the organization. Ethical communicators need to follow the privacy policy for their organization because the unauthorized release of information could lead to consequences up to and including termination.{{sfn|Balzotti|2022|p=83}}
==='''The Public'''===
Organizations are obligated to treat customers fairly. Technical communicators must convey that an organization's products or services are safe and effective. {{sfn|Markel|2009}}
==='''The Environment'''===
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, 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 up to $50,000 for each day of the violation.{{sfn|Environmental Protection Agency|2023}}
==='''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.
Some social media sites, such as Facebook, have begun to flag certain articles posted on the site as being questionable in their representation of facts or occurrences. Despite the widespread understanding and use of disinformation available today, digital writers need to be aware of their intent and the audience's needs and wants from their digital communication.{{sfn|Lucas|2023f}} Ethical considerations regarding citing sources, cross-referencing information, and using primary sources are good practices for maintaining ethical standing and credibility as a digital writer.
To help mitigate the problem of disinformation, technical writers should utilize gatekeepers. These individuals verify the accuracy of the information before it is distributed to primary readers. This helps protect the author from any ethical and/or legal issues.{{sfn|Balzotti|2022|p=83}}


=='''Pedagogical Approaches'''==
=='''Pedagogical Approaches'''==
Line 344: Line 310:
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'''==
=='''Challenges and Ethical Considerations'''==
==='''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}}


==='''Challenges'''===
==='''Challenges'''===
Line 361: Line 325:
==='''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}}
==='''Ethical Considerations'''===
In technical workplaces, resolving ethical dilemmas will be part of one's job. Resources, time, and reputations are at stake, so one will feel pressure to overpromise, underdeliver, bend the rules, cook the numbers, or exaggerate results. Technical fields are also highly competitive, so people sometimes stretch a little further than they should. Ethical dilemmas can force one into situations in which all choices seem unsatisfactory.{{sfn|Johnson-Sheehan|2018|pp=71-84}}
The Society for Technical Communication (STC) is the world's oldest professional association dedicated to advancing the field of technical communication.{{sfn|Society for Technical Communication|2023a}} The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.{{sfn|Society for Technical Communication|2023b}}
Technical communicators also have to be careful to avoid plagiarism, or taking ideas, thoughts, or words from someone else and passing them off as one's own.{{sfn|Carroll|2010|p=280}}
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'''====
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}}
===='''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}}
===='''The Environment'''====
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'''====
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.
Some social media sites, such as Facebook, have begun to flag certain articles posted on the site as being questionable in their representation of facts or occurrences. Despite the widespread understanding and use of disinformation available today, digital writers need to be aware of their intent and the audience's needs and wants from their digital communication.{{sfn|Lucas|2023f}} Ethical considerations regarding citing sources, cross-referencing information, and using primary sources are good practices for maintaining ethical standing and credibility as a digital writer.
To help mitigate the problem of disinformation, technical writers should utilize gatekeepers. These individuals verify the accuracy of the information before it is distributed to primary readers. This helps protect the author from any ethical and/or legal issues.{{sfn|Balzotti|2022|p=83}}


=='''References'''==
=='''References'''==
32

edits