LitWiki - User contributions [en]

Technical Writing in the Digital Age

2023-11-14T15:52:28Z

Apjones428: /* Search Engine Optimization (SEO) and Technical Writing in the Digital Age */

'''Technical Writing in the Digital Age''' represents the dynamic and evolving discipline of creating written materials that convey complex information, instructions, and technical concepts in the context of contemporary digital technologies.<ref name="Markel">{{cite book |last=Markel |first=Mike |date=2021 |title=Technical Communication (13th ed.) |url=https://openlibrary.org/books/OL36001026M/Technical_Communication |location=Boston/New York |publisher=Bedford/St. Martin’s |pages=182-186 |isbn=9781319307691 |author-link= |ref=harv }}</ref> Its purview encompasses the creation, dissemination, and management of technical documents and content within an expansive digital landscape.

Major considerations within this domain revolve around adapting traditional principles of rhetoric to digital platforms, ensuring effective communication in an era defined by rapid technological advancements. Key factors include integrating multimedia elements, user-centered design principles, and ethical considerations like accessibility and inclusivity.<ref name=":1">Carroll, Brian, (2010). ''Writing for Digital Media.'' New York: Routledge. </ref> 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. The use of multi-modality and the interfacing of multiple media platforms and sources also plays a role in digital technical writing.<ref>{{cite web
| url = https://grlucas.net/grl/CompFAQ/Digital_Writing/Multimodal_Approach
| title = multimodal-approaches-in-technical-writing
| last = Lucas
| first= Gerald-R
| date= September 19, 2023
| website = Gerald-R-Lucas
| publisher = ghost
| access-date =October 30, 2023
| ref = harv
}}</ref> 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. <ref>{{cite web
| url = https://grlucas.net/grl/CompFAQ/Technical_Writing
| title = Defining Technical Writing
| last = Lucas
| first= Gerald-R
| date= September 14, 2023
| website = Gerald-R-Lucas
| publisher = ghost
| access-date =November 7, 2023
| ref = harv
}}</ref>

==Overview==

===Types of Technical Communication===
Common types of technical communication include instructions, user guides, reports, proposals, memos, and procedures. <ref>{{cite book
| last1 = Lannon
| first1 = John
| last2 = Gurak
| first2 = Laura
| date = 2022
| title = Technical Communication
| edition = 15th
| publisher = Pearson Education Limited
| location = Essex, United Kingdom
| page = 30
| isbn = 1-292-36359-2
}}</ref>
{{sfn|Mussack|2021}}

=== Aims of Technical Communication ===
As much as technical communication is a discipline in and of itself, it also exists within many other disciplines. Examples of technical communication communities can be found among such fields as varied as education, business, and science. Technical documentation within any domain typically embodies a similar aim: to help its audience act toward some sort of task or goal. {{sfn|Markel|2007}}

=== Characteristics of Technical Communication ===
Because technical communication is intended to guide an audience, it must be assembled in such a way that it is very 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 that is delivered logically is well-organized and clear and can be approached in a manner that will be coherent for most users. Technical information that is appropriate contains elements and steps that are suitable for the intended purpose and audience.

== Features of Technical Communication ==
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}}

=== '''Accurate''' ===

==== Standards Compliant ====
Many technical fields have industry-specific regulations and guidelines which are determined by governing bodies and that also have an impact on their technical communication. Adhering to company standards in technical documents is crucial for consistency, professionalism, and ensuring that communication aligns with company expectations. Many companies have a style guide that outlines preferred language, tone, and formatting.

==== Detailed ====
Accurate information that is delivered with precision and specificity is essential to providing communication that is unambiguous and free of inconsistencies. Reviewing and revising the document is a key aspect in attention to detail. This includes checking for any overlooked errors, inconsistencies, or areas that may need clarification.

==== Objective ====
Objective communication is presented in an unbiased and impartial manner and is free of personal opinions. It relies upon facts and evidence and avoids an overly emotional tone. This approach is particularly important in fields such as journalism, scientific reporting, and technical communication were accuracy and impartiality are essential.

===== Clear and Concise =====
Clear language is organized logically, is not unnecessarily involved, and is easily understood by the target audience. It will avoid needless jargon and complexity. Good technical communication expresses meaning in a way that is straightforward and that avoids redundant words or excessive explanations. It is easy to both absorb and process.

=== '''Soundness''' ===

==== Format and Organization ====
Technical documents should be formatted in a way that is consistent with the norms and standards of applicable professional fields. Additionally, formatting should adhere to guidelines which enhance usability. Information should be logically organized for easy reading comprehension. This may involve using headings, subheadings, bullet points, and numbered lists. A well-organized document enhances the effective transfer of knowledge.

==== Visuals ====
Technical communication utilizes visuals strategically to facilitate understanding of textual content. Visuals such as diagrams, charts, graphs or images can enhance understanding on a technical document. When presented properly, they can elucidate difficult concepts and make material accessible to a more diverse audience.

=== '''Appropriateness''' ===

==== Audience-specific ====
Where possible, technical communication should be customized to align with the knowledge and needs of its audience. Tailor the communication style, tone and level of detail to match the audience's knowledge and expertise. Consider factors like technical background, familiarity with the subject, and specific user needs.

==Historical Context==
===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.<ref>{{cite magazine |last=Malone |first=Ed |date=2008 |title=Joseph D. Chapline: Technical Communication's Mozart |url=https://web.mst.edu/~malonee/chapline.pdf |magazine=<i>IEEE Professional Communication Society Newsletter</i> |access-date=October 31, 2023 }}.</ref> 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 of Technical Communication in 1960.<ref>{{cite journal |last1=Edward |first1=Malone |date=November 2011 |title=The First Wave (1953–1961) of the Professionalization Movement in Technical Communication |url=https://www.stc.org/techcomm/wp-content/uploads/sites/3/2016/08/november-2011-58-4.pdf |journal=Technical Communication |volume=58 |issue=4 |pages=285 - 306 |doi= |access-date=October 11, 2023}}</ref>

The need for paperwork ushered in by World War II served as the driving force for the technical writing profession in the United States. {{sfn|Rathbone|1958}} This was a time years before the computer and photocopier became common office equipment. At that time the role of the technical writer revolved solely around words, their primary work tools consisted of either a pencil or ink pen and paper. Upon the technical writer writing words on paper, a typist or clerical worker would then type the words with a typewriter.

Advances in technology thrust the technical writing profession into a new era. The work of the technical writer may now also include not only text, but also images, drawings, and computer-based media. The current role of the technical writer is not only to write, but they may also be involved in research and information gathering, speaking with technical experts, and selecting document mediums and project tools. {{sfn|Macari|2023}}

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}} And 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}}

== Digital Technologies and Technical Writing==
With the rise of digital technology, technical writing has had to adapt to the needs of a digital era. The predominant impact of this revolution was that it made technical communication more accessible by increasing the breadth of its viewers. The world-wide web is public, and thus, it can be accessed by anyone with access to the internet.

Online word processors such as [https://www.google.com/docs/about/ Google Docs] and [https://www.microsoft.com/en-us/microsoft-365/sharepoint/collaboration SharePoint] allow documents to be easily disseminated. Comment capability allows audience members to interact with one another as well as with the document author. Hypertext permits online authors to link the works of various others to their personal websites and vice versa. In all, technical documentation posted online can grow a considerable audience over time. However, many aspects of effective technical writing, such as clarity, conciseness, completeness, and correctness, still need to be applied to technical writing created for digital interfaces. {{sfn|Carroll|2010|p=24}}

==Personas in Digital Writing==
Personas in the context of digital writing 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).<ref>https://grlucas.net/grl/CompFAQ/Digital_Writing/Personas</ref> 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.<ref>{{cite web
| url= https://smashingmagazine.com/2014/08/a-closer-look-at-personas-part-2/
| title= A Closer Look at Personas: A Guide to Developing The Right Ones (Part 2)
| last= Goltz | first= Shlomo | date= August 13, 2014
| website= smashingmagazine
|publisher=
|access-date= November 13, 2023 }}</ref>

==Rhetorical Strategies in the Digital Age==
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. <ref>{{cite book |last=Gagich |first=Melanie |title=Writing Arguments in Stem |publisher=Digital Commons |date=n.d. |chapter=Rhetorical Appeals: Logos, Pathos, and Ethos Defined |url=https://digitalcommons.calpoly.edu/cgi/viewcontent.cgi?article=1000&context=oercoursematerials#page=44 |pages=34-37 }}</ref>

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.<ref name="Markel"></ref> Hyperlinks can be used to provide additional information that supports the author's ideas. Nevertheless, the writer's basic task of informing and persuading an audience is the same in digital communication as in other forms of writing.<ref>{{cite book |last=Devos |first=Danielle |date=2010 |title=Because Digital Writing Matters: Improving Student Writing in Online and Multimedia Environments |location=San Francisco |publisher=Jossey-Bass |pages=105 |isbn=9780470892237 |url=https://openlibrary.org/books/OL34593323M/Because_Digital_Writing_Matters }}</ref>

Rhetorical analysis involves analyzing the demographics and habits of an intended audience. The information gathered allows writers to craft messages that appeal to the target audience. In the digital age, websites and social media platforms convey rhetorical messages. <ref>{{cite book
| last =Lawrence
| first =Dan
| date =2022
| title =Digital Writing
| location =Peterborough, Ontario, Canada
| publisher =Broadview Press
| page = 6-14
| isbn =9781770488229
}}</ref>

==Search Engine Optimization (SEO) and Technical Writing in the Digital Age==
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.<ref name=":3">Lucas, Gerald R. (2023). ''Search Engine Optimization: Strategies and Best Practices for Effective Online Visibility.'' GRLucas.net. Retrieved: https://grlucas.net/grl/CompFAQ/Digital_Writing/SEO</ref> 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. <ref name=":6">Barr, Chris. (2010). ''Yahoo! Style Guide.'' New York: St. Martin's.</ref>

=== Using 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 worse matches. Depending on where the website falls in that scale based on the specific keywords being searched by a user, influences where the website pops up in the associated search results.<ref name=":6" /> 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 engine's 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.<ref name=":3" />

=== Using 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.<ref name=":3" />

=== 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.<ref name=":3" />

==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 |2014| }}

===Characteristics of Digital Documents===

====Accessibility ====
Website content should be designed in accordance with Web Content Accessibility Guidelines (WCAG) to ensure that individuals with disabilities are able to access the same information as those without disabilities.{{sfn|WAI |2022| }} It is a legal requirement to include accessibility features in website design.{{sfn|WAI || }} There are four different types of impairment that can affect how a user interacts and perceives digital documents: vision, mobility, auditory, and cognitive.{{sfn|Robbins|2018|p=42}}Digital documents will need to be optimized so that information can be accessed by hardware and software tools used by people with disabilities.{{sfn|Barr|2010|p=103-104}}

====Readability====
Digital documents rely on the "Seven Cs" of precise writing to be effective and increase readability. Forms of technical writing must have readability. Readability is a term used to determine whether the content has clarity, conciseness and courtesy.<ref>Zeleznik, J. M., Burnett, R. E., & Benson, P. J. (1999). ''Technical Writing : What It Is and How to Do It''. National Book Network. p. 207.</ref> The other four Cs are coherent, concrete, correct and complete.<ref>Last, Suzan (2019). ''Technical Writing Essentials.'' Victoria, B.C. University of Victoria. ISBN: 9781550586657 https://pressbooks.bccampus.ca/technicalwriting/chapter/communicatingprecision/</ref>

====Scannability====
A document's scannability is determined by the ease in which it can be scanned to determine meaning. Readers often scan pages for words and phrases that align with their task or interests, as well as for trigger words that are deeply ingrained.{{sfn|Krug|2014|p=23}}The most effective web content is concise and simple to scan, making it easy for users to find the important information. Breaking up text into interesting, easy-to-read sections helps users quickly find information. {{sfn|Barr|2010|p=103}}

====Hyperlinking====
Hyperlinking is a quick and efficient method for directing readers to relevant information in digital documents, facilitating seamless navigation between sections, references, and external resources.{{sfn|Carroll|2010|p=79}}

====Multimedia====
Digital documents can incorporate multimedia elements like images, audio, video, and interactive content, enhancing engagement through visual and auditory elements. Multiple media formats work best when sharing new, complicated ideas.{{sfn|Carroll|2010|p=36}} Increasing multimodality on a website improves engagement, usability, and accessibility. This can improve the impact of the website's standings in SERPs.<ref name=":5" />

====Version Control====
Version control is a characteristic of digital documents that allows for the tracking of edits and revisions to digital documents. In collaborative writing, version control helps maintain the document with accountability and transparency.<ref name=":2" />

==== Remote Collaboration ====
One form of collaborative technical writing is a wiki, which is a "Web site developed collaboratively by a community of users, allowing any user to add and edit content."<ref>{{cite web
| url = https://grlucas.net/grl/Writing_on_a_Wiki
| title = writing on a wiki
| last = Lucas
| first= Gerald
| date= May 18, 2021
| website = Gerald-R-Lucas
| publisher = MediaWiki
| access-date =October 31, 2023
| quote = Web site developed collaboratively by a community of users, allowing any user to add and edit content.
| ref = harv
}}</ref>

One of the predominant elements of a wiki is that it is defined as being open source. As a result, anyone can modify it regardless of their geographic locations.

==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.

====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. <ref>{{cite book
| last1 = Lannon | first1 = John M.
| first2 = Laura J. | last2 = Gurak
| title = ''Technical Communication Fifteenth Edition''
| location = United States
| publisher = Pearson
| pages = 292–293
| date = 2020
| isbn = 978-0-13-520322-4}}</ref>

====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.
<ref>{{cite book
| last1 = Parkinson | first1 = Mike
| title = A Trainer’s Guide to PowerPoint: Best Practices for Master Presenters
| location = United States
| publisher = Association for Talent Development
| pages = Chapter 4. PowerPoint Tips, Tricks, and Secrets
| date = 2018}}</ref>

==User Experience==
User experience is how a product works from the perspective of the user. Digital documents can be created with efficient user experiences by focusing on user-centered design and designing the document with the user in mind. <ref> {{cite book | last = Garrett | first = Jesse James | title = The Elements of User Experience: User-Centered Design for the Web and Beyond | publisher = New Riders | edition = 2nd | date = 2011 | location = Berkeley, CA | page = 17}} </ref>

==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<ref>Johnson-Sheehan, Richard. “Managing Ethical Challenges.” ''Technical Communication Today'', 6th ed., Pearson, Boston, MA, 2018, pp. 71–84.</ref>.

The Society for Technical Communication (STC) is the world's oldest professional association dedicated to advancing the field of technical communication.<ref>“About STC.” ''Society for Technical Communication'', 19 May 2021, [https://www.stc.org/about-stc/ www.stc.org/about-stc/] Retrieved October 27, 2023.</ref> The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.<ref>“Ethical Principles.” ''Society for Technical Communication'', 20 May 2021, [https://www.stc.org/about-stc/ethical-principles/ www.stc.org/about-stc/ethical-principles/] Retrieved October 27, 2023.</ref>

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.<ref name=":5" />

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.<ref name=":0">Markel, Mike. ''Technical Communication''. 9th ed., Bedford/St. Martin’s, Boston, 2009. p.22-25.</ref>

=== The Employer ===
Obligations to one's employer include competence and diligence, honesty and candor, confidentiality, and loyalty.<ref name=":0" /> 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.<ref name=":4" />

=== 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.<ref name=":0" />

=== 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. Disposal of hazardous waste is far more costly than dumping it. Organizations could be tempted to skirt the legal procedures.<ref name=":0" /> One would hope that the penalty of 5 years and/or up to $50,000 per day for knowingly disposing of hazardous waste in a way contrary to U.S. Environmental Protection Agency regulations would be a sufficient deterrent.<ref>{{Citation |url=https://www.epa.gov/enforcement/criminal-provisions-resource-conservation-and-recovery-act-rcra
|title=Criminal Provisions of the Resource Conservation and Recovery Act
|website=United States Environmental Protection Agency
|access-date=November 6, 2023}}</ref>
===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.<ref>Lawrence, Dan. (2022). ''Digital Writing: A Guide to Writing for Social Media and the Web.'' Broadview Press. </ref> 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.<ref>Lucas, Gerald. (September 13, 2023). "Audience-Centric Style in Digital Writing" in ''From Reading to Writing: A Composition FAQ Textbook.'' Retrieved October 22, 2023. https://grlucas.net/grl/CompFAQ/Digital_Writing/Style</ref> 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.<ref name=":4">"Ethics" Balzotti, Jon (2022). ''Technical Communication: A Design-Centric Approach''. New York. Routledge. p. 83. ISBN 978-1-003-00606-0</ref>

==Pedagogical Approaches==
Barriers to teaching technical communications include the speed at which digital tools evolve and the complexity of software. <ref>{{cite journal |last1=Hovde |first1=Marjorie |last2=Renguette |first2=Corinne |date=2017 |title=Technological Literacy: A Framework for Teaching Technical Communication Software Tools |journal=Technical Communication Quarterly |volume=26 |pages=395-411 |doi=10.1080/10572252.2017.1385998}}</ref>

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. Others even used emoticons. Colleges and universities now must focus on educating students on the different forms of written communication and when best to employ them.<ref name=":5">Carroll, Brian. ''Writing for Digital Media''. Routledge, New York, 2010. p. 280.</ref>

==Future Trends and Challenges==
===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. <ref>{{cite web
| url = https://www.bls.gov/ooh/media-and-communication/technical-writers.htm#tab-6
| title = Occupational Outlook Handbook
| last =
| first=
| date= September 6, 2023
| website = Bureau of Labor Statistics
| publisher =
| access-date = November 7, 2023
|ref=harv
}}</ref>

===Challenges===
Among others, a prominent barrier to technical writers is the dependency on input information accuracy. Outdated, incorrect, or inconsistent data delays the publication, requires more reparative efforts, and decreases productivity. <ref>Common problems in technical writing and how to resolve them (componize.com)</ref> Also, Technical writers often have to contend with complex, outdated or unsuitable tools. This can make their job more difficult and time-consuming, and can lead to frustration and errors.<ref>[https://componize.com/common-problems-in-technical-writing-and-how-to-resolve-them/#:~:text=Technical%20writers%20often%20have%20to,longer%20supported%20by%20the%20vendor]</ref>

===Artificial Intelligence===
Artificial intelligence programs, utilizing natural language processing, are capable of producing technical writing and have advanced in recent years becoming more adept.<ref>{{cite web
| url = https://www.forbes.com/sites/bernardmarr/2023/01/23/how-chatgpt-and-natural-language-technology-might-affect-your-job-if-you-are-a-computer-programmer/?sh=6d9acf79174b
| title = How ChatGPT And Natural Language Technology Might Affect Your Job If You Are A Computer Programmer
| last = Marr
| first= Bernard
| date= January 23, 2023
| website = Forbes
| publisher =
| access-date =October 31, 2023
|quote=
|ref=harv
}}</ref>
One such program is [https://en.wikipedia.org/wiki/ChatGPT ChatGPT], which uses machine learning to produce texts with human-like style and tone. <ref>{{cite web | url =https://uca.edu/cetal/chat-gpt/ | title =Chat GPT: What is it? | last = | first = | date = | website =University of Central Arkansas | publisher = | access-date =October 9, 2023 }}</ref> Another leader in this area, Contentbot, uses a WordPress plugin which gives blog writers ideas to enhance their posts which are shared via email. <ref>Siddiqui, Zafar (January 2022). "Will Best Artificial Intelligence Take Over any Technical Content Writer?" The Writing Cooperative. https://writingcooperative.com/intricacies-of-ai-tools-can-ai-tools-take-over-the-jobs-of-technical-writers-af36836f625c</ref>

===Plagiarism===
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===
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}}

==References==
===Citations===
{{Reflist}}

===Bibliography ===
{{Refbegin|30em}} 
*{{cite book |last=Carroll |first=Brian |date=2010 |title=Writing for Digital Media |url= |location=New York |publisher=Routledge }}
*{{cite book |last=Barr |first=Chris |date=2010 |title=Yahoo! Style Guide |url= |location=New York |publisher=St. Martin's }}
* {{cite magazine |last=Grimstead |first=Deborah M. |date=1999 |title=Technical Writers are in Demand: Do You Have The Right Stuff? |magazine=Black Collegian |pages=128 |ref=harv }}
* {{cite news |last=Klein |first=Alyson |date=2023 |title=ChatGPT Cheating: What to Do When It Happens |url=https://www.edweek.org/technology/chatgpt-cheating-what-to-do-when-it-happens/ |work=Education Week |location=Bethesda, MD |access-date=2023-11-05 |ref=harv }}
* {{cite book |last=Krug |first=Steve |date=2014 |title=Don’t Make Me Think, Revisited|url= |location=Berkeley, CA |publisher=New Riders |pages= |isbn= |author-link= |ref=harv }}
* {{cite web|url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Documents|title=Exploring the Dichotomy: A Comparative Analysis of Digital and Paper Documents |last=Lucas |first=Gerald |date=2023 |website=grlucas.net |publisher= |access-date=2023-10-29 |quote= |ref=harv }}
* {{cite book |last=Markel |first=Mike |date=2007 |title=Technical Communication (13th ed.) |url=https://vdocuments.site/technical-communication-13th-edition.html?|page=46 |location=Boston |publisher=Beford/St. Martin’s |page=5 |ref=harv }}
* {{cite book |last=Mussack |first=Brigitte |date=2021 |title=Introduction to Technical and Professional Communication |url=https://pressbooks.umn.edu/techwriting/front-matter/introduction/ |location= |publisher=Creative Commons Attribution NonCommercial |pages=n.p. |author-link= |ref=harv }}
* {{cite book |last=Perelman |first=Leslie |date=1998 |title=The Mayfield Handbook of Technical and Scientific Writing |url=https://www.mit.edu/course/21/21.guide/ |location=Mountain View |publisher=Mayfield Publishing Company |pages=n.p. |isbn= |author-link= |ref=harv}}
* {{cite journal |last=Rathbone |first=Robert |title=Growth of the technical writing profession |journal=STWE Review |volume=5 |issue=1 |date=1958 |pages=5-16 |ref=harv }}
*{{cite book |last=Robbins |first=Jennifer Niederst |date=2018 |title=Learning Web Design: A Beginner’s Guide to HTML, CSS, JavaScript, and Web Graphics (5th ed.) |url= |location=Sebastopol, CA |publisher= O’Reilly Media, Inc. }}
* {{cite web |url=https://www.businessinsider.com/chatgpt-jobs-at-risk-replacement-artificial-intelligence-ai-labor-trends-2023-02 |title=ChatGPT may be coming for our jobs. Here are the 10 roles AI is most likely to replace |last=Mok |first=Aaron |date=2023 |website=Insider |publisher=Business Insider |access-date= 2023-11-05 |ref=harv }}
* {{cite web |url=https://www.indeed.com/career-advice/careers/what-does-a-technical-writer-do |title=What Does a Technical Writer Do? (Plus How To Become One) |last=Macari |first=Sabina |date=2023 |website=indeed.com |publisher=Indeed |access-date=2023-11-05 |ref=harv }}
* {{cite web |url=https://www.managementnote.com/features-of-technical-communication/#google_vignette |title=Features of Technical Communication |last=smirti |date=2022 |website=managementnote.com |publisher=Management Note |access-date= 2023-11-05 |ref=harv }}
* {{cite web|url=https://www.w3.org/WAI/fundamentals/accessibility-intro/|title=Introduction to Web Accessibility|last=WAI |first=|date=2022 |website=W3.org|publisher= |access-date= 2023-10-26 |quote= |ref=harv }}
* {{cite web|url=https://wcag.com/legal/|title=Accessibility and the Law|last=WAI |first=|date= |website=W3.org|publisher= |access-date= 2023-10-26 |quote= |ref=harv }}
{{Refend}}

[[Category:Fall 2023]]
[[Category:ENGL 5106]]

Talk:Technical Writing in the Digital Age

2023-11-13T17:47:02Z

Apjones428:

==Layout and Lead==
Just to get this thing going, I have created the article, developed a rudimentary layout, and added a lead written by ChatGTP. '''All of this may be kept or changed'''. I would certainly revise or rewrite the lead. Questions, ideas, discussion, and comments about the project should be posted here. I'm looking forward to seeing what you all come up with this semester. —[[User:Admin|Admin]] ([[User talk:Admin|talk]]) 09:38, 3 October 2023 (EDT)

==Citation question==
I am citing a later edition of a source that is cited elsewhere on the page. (Markel, Mike, and Selber, Stuart. (2021). Technical Communication (13th ed). This version has a second author. Should these entries be combined somehow?
:{{Reply to|Beth Kennedy}} Yes. If you’re using the updated version, update the earlier source. Great question, but don’t forget to sign your talk posts. —[[User:Admin|Admin]] ([[User talk:Admin|talk]]) 14:35, 2 November 2023 (EDT)

==Shortened Footnotes==
I added the template to the project. All you need to do is add the code for your reference under Bibliography and then the SFN code under citations. I made a quick, visual [https://docs.google.com/document/d/1QGEr_RhDMKZvPqvncmDR9eoHRmOLeFkXpzp9nzFb-Sg/edit?usp=sharing step-by-step] that show you how to pull the [https://grlucas.net/grl/April%2015,%202019 template] and paste the code.--[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 14:11, 11 November 2023 (EST)
Nice work! Thanks [[User:Cggreen|Cggreen]] ([[User talk:Cggreen|talk]]) 09:28, 13 November 2023 (EST)

== References question ==

Should References be the heading, followed by Bibliography as a subheading? Would this only apply if we are using Notes, Citations, and a Bibliography?--[[User:CEToledo|CEToledo]] ([[User talk:CEToledo|talk]]) 19:14, 4 November 2023 (EDT)
: {{Reply to|CEToledo}} You can do whatever seems logical for this. Check out [[w:The Man Who Studied Yoga|The Man Who Studied Yoga]] to see a way to approach a references section. —[[User:Admin|Admin]] ([[User talk:Admin|talk]]) 07:27, 6 November 2023 (EST)

--[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 12:50, 6 November 2023 (EST)== Shortened footnote code ==
I am having trouble understanding where the placement of the works cited and the shortened footnote code should be. I sent an inquiry email to Dr. Lucas. [[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 14:41, 5 November 2023 (EST)
:{{Reply to|Debbiebwolfe}} I would put references at the bottom, in a bibliography section. Then you can use the shortened footnotes in the body. This is an easier approach for everyone editing, as they can easily consult the bibliography to see if a reference has been used and entered. —07:30, 6 November 2023 (EST)

Do I need to have the citation section? I see that my shorten footnotes are displaying in the reference section.--[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 15:48, 6 November 2023 (EST)

== Paragraph Blocks ==

I can't believe how well and quickly this is coming along. At any rate, on to my dispute...are we adhering to any particular standard in terms of the size of paragraph blocks? Too long and it reduces the likelihood of it being read, too brief (a single sentence) and the topic/subtopic of the contribution seems too unnecessary to even mention. -- [[User:CBrown]]

I separated the Digital Document and User Experience sections. I think paragraph blocks should have around three to four sentences max. More than that, we can create a new subheading.--[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 06:41, 8 November 2023 (EST)

The Ethical Considerations section seems to run together. Can it be separated into smaller sections with the primary categories as headings: "Employer," "Public," and "Environment?" --[[User:APitts]]

@APitts I agree that it would work better to separate into smaller sections. It would make them appear neater and more organized. -- [[User: HRoney]]

Can we agree then that there are no more additions to the "Ethical Considerations" section? [[User:Cggreen|Cggreen]] ([[User talk:Cggreen|talk]]) 09:50, 13 November 2023 (EST)

Edits have been made to separate the Ethical Considerations portion into categories. Can someone look over my work or make any edits as you see fit? -- [[User: APitts]]

== Topics vs. Subtopics ==

Why are future trends and challenges separate subtopics under the future trends and challenges topic? Should there not be an overview of future trends and challenges followed by subtopics of examples of future trends and challenges, e.g. artificial intelligence. -- [[User:CBrown]]

:I am in favor of this idea/change if others agree. --[[User:Elaine Streeter|Elaine Streeter]] ([[User talk:Elaine Streeter|talk]]) 14:37, 10 November 2023 (EST)

:{{Reply to|CBrown}} The problem here is that the heading Future Trends and Challenges has room for interpretation. I think the section should just be titled Future Trends. I also think an overview of future trends could be appropriate provided information from its subheadings is not unnecessarily repeated. The material under the Challenges subheading could be relocated to another heading but I would like to hear other opinions on this proposal. —[[User:AWilliamson|AWilliamson]] ([[User talk:AWilliamson|talk]]) 20:13, 10 November 2023 (EST)
::{{Reply to |AWilliamson}} While Challenges could be a standalone heading, are we talking current or future challenges? If current, then I believe it would be best as a standalone heading. If future, then it would fit in the current format. If both, then standalone. --[[User:Mroma98|Mike Romano]] ([[User talk:Mroma98|talk]]) 20:04, 11 November 2023 (EST)

:::{{Reply to |Mroma98}} I agree with all of your points. My interpretation of the information contained within the Challenges subheading is that it refers to current challenges. I would prefer to either get input from the individual who originally contributed the content or to obtain consensus from other editors before modifying. —[[User:AWilliamson|AWilliamson]] ([[User talk:AWilliamson|talk]]) 20:47, 11 November 2023 (EST)
::::{{Reply to |AWilliamson}} OK. We're on the same page. I agree with both of your preferences. --[[User:Mroma98|Mike Romano]] ([[User talk:Mroma98|talk]]) 21:04, 11 November 2023 (EST)
::::{{Reply to |AWilliamson}} I agree that "Future Trends" and "Challenges" could be separated into two different subtopics. After reviewing the edit history, I believe Dr. Lucas is the one who created this heading, and he has indicated that any of the initial outline can be changed or removed. To me, it seems like almost everything currently in this section falls under the "Challenges" category, so that could be its own section. Then the "Future Trends" can be further developed. --[[User:Emmakd|Emma D.]] ([[User talk:Emmakd|talk]]) 15:29, 12 November 2023 (EST)

Under Ethical Considerations, I removed the second person pronouns with a more neutral one. Though the paragraph fits with the topic, writing in the second person is not standard practice for Wikipedia/Litwiki. Litwiki is the intellectual property of Dr. Gerald R. Lucas, PhD, and the rules and format of Wikipedia apply to Litwiki. --[[User:Mroma98|Mike Romano]] ([[User talk:Mroma98|talk]]) 15:07, 11 November 2023 (EST)

== Include external links section? ==

There are a few external (non-wikipedia) links in the article. Should we remove/replace the external links or create an External Links section? According to [https://en.wikipedia.org/wiki/Wikipedia:External%20links Wikipedia:External links]: "With rare exceptions, external links should not be used in the body of an article. Instead, include appropriate external links in an "External links" section at the end of the article, and in the appropriate location within an infobox, if applicable." —[[User:AWilliamson|AWilliamson]] ([[User talk:AWilliamson|talk]]) 20:50, 10 November 2023 (EST)

:{{Reply to|AWilliamson}} I think we should as this follows the Wikipedia guidelines as well as Dr. Lucas' earlier advice. --[[User:Apjones428|Apjones428]] ([[User talk:Apjones428|talk]]) 12:47, 13 November 2023 (EST)

==Heading Structure==
There are inconsistencies with the subheading structure on the page. I propose we establish the heading structure as follows: Heading 1 (for section titles), Subheading 1 (H2 for subsections within the main section), and Subheading 2 (H3 for items that need to be defined). No italics in subheadings.--[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 14:11, 11 November 2023 (EST)
:Debbie, I agree. Your suggestion makes sense, as there should be consistency throughout. --[[User:Mroma98|Mike Romano]] ([[User talk:Mroma98|talk]]) 19:58, 11 November 2023 (EST)

: {{Reply to|Debbiebwolfe}} I support your proposal. — [[User:AWilliamson|AWilliamson]] ([[User talk:AWilliamson|talk]]) 20:56, 11 November 2023 (EST)

I edited the headings and subheadings. Thanks for your input everyone--[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 18:52, 12 November 2023 (EST)

== Collaboration and Version Control ==

I think this section can be added to the digital documentation section.--[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 18:51, 12 November 2023 (EST)

== Features of Technical Communication Section ==
When compared to the other sections of the talk page, this section seems a bit choppy. I'm thinking we can get a better intro paragraph and maybe either add longer paragraphs for each item, or combine some of the subheadings together. Any thoughts on this? --[[User:Amanda.Austin1|Amanda Austin]] ([[User talk:Amanda.Austin1|talk]]) 21:19, 12 November 2023 (EST)

I do think that longer paragraphs will make the section more thorough. Maybe sections like "clear" and "concise" could be combined? [[User: HRoney]]

==Additional Sections==
What additional sections would we like to add to this article? I will be adding in more on multi-modality as well as more information to the SEO section of the page. Other thoughts? --[[User:Apjones428|Apjones428]] ([[User talk:Apjones428|talk]]) 12:47, 13 November 2023 (EST)

Technical Writing in the Digital Age

2023-11-01T12:59:41Z

Apjones428: Updated reference with capitalization

Technical Writing in the Digital Age

2023-10-31T18:58:42Z

Apjones428:

Technical Writing in the Digital Age

2023-10-31T18:48:32Z

Apjones428:

Technical Writing in the Digital Age

2023-10-30T20:16:05Z

Apjones428:

Technical Writing in the Digital Age

2023-10-30T20:15:45Z

Apjones428:

Technical Writing in the Digital Age

2023-10-30T20:13:21Z

Apjones428:

Technical Writing in the Digital Age

2023-10-30T20:12:59Z

Apjones428: Added in a sentence and citation on multimodal media

Technical Writing in the Digital Age

2023-10-30T14:57:29Z

Apjones428: /* References */

Technical Writing in the Digital Age

2023-10-23T20:22:06Z

Apjones428: /* Ethical Considerations */

User talk:Elaine Streeter

2023-10-06T13:59:03Z

Apjones428:

== A barnstar for you! ==

{| style="background-color: #fdffe7; border: 1px solid #fceb92;"
|rowspan="2" style="vertical-align: middle; padding: 5px;" | [[File:Graphic Designer Barnstar Hires.png|100px]]
|style="font-size: x-large; padding: 3px 3px 0 3px; height: 1.5em;" | '''The Graphic Designer's Barnstar'''
|-
|style="vertical-align: middle; padding: 3px;" | Looking forward to working with you! [[User:Apjones428|Apjones428]] ([[User talk:Apjones428|talk]]) 09:58, 6 October 2023 (EDT)
|}

User talk:Elaine Streeter

2023-10-06T13:58:48Z

Apjones428: /* A barnstar for you! */ new WikiLove message

Hello again Elaine! I loved your work in the last class so I'm looking forward to seeing what you do here too!

== A barnstar for you! ==

{| style="background-color: #fdffe7; border: 1px solid #fceb92;"
|rowspan="2" style="vertical-align: middle; padding: 5px;" | [[File:Graphic Designer Barnstar Hires.png|100px]]
|style="font-size: x-large; padding: 3px 3px 0 3px; height: 1.5em;" | '''The Graphic Designer's Barnstar'''
|-
|style="vertical-align: middle; padding: 3px;" | Looking forward to working with you! [[User:Apjones428|Apjones428]] ([[User talk:Apjones428|talk]]) 09:58, 6 October 2023 (EDT)
|}

User talk:Elaine Streeter

2023-10-06T13:57:00Z

Apjones428: A welcome to the course

Hello again Elaine! I loved your work in the last class so I'm looking forward to seeing what you do here too!

ENGL 5106

2023-10-06T00:15:53Z

Apjones428: /* Course Members */

{{Big|Welcome to the wiki page for ENGL 5106: Technical Writing in the Digital Age.}}

The fall 2023 sections of ENGL 5106 (CRNs 82482 and 84154) will use LitWiki for their collaborative wiki project.

== Course Information ==
* [[grl:ENGL 5106/Fall 2023|Syllabus]]

== Course Members ==
After you get an account, you may add it below. Next, be sure to write a short bio on your user page.
* {{u|Glucas|Dr. Lucas}}
* [[Debbie Wolfe]]
* [[User:Kleinberger|Kimberly Leinberger]]
* [[User:Apjones428|Ashley Jones]]

==Project==
* [[Technical Writing in the Digital Age]]

[[Category:ENGL 5106]]

User:Apjones428

2023-10-06T00:15:07Z

Apjones428: Created a description and added an image.

[[File:AJonesHead.jpg|alt=A brunette woman with curly hair smiles at the camera.|thumb|A faculty picture of Ashley Jones]]
Ashley Jones is an assistant professor of communication and emerging media who is currently working toward a Master of Arts in Digital Communication and Technical Writing. She is currently working on research surrounding game studies and the political valency of exploring games through feminist and queer perspectives.

File:AJonesHead.jpg

2023-10-06T00:13:48Z

Apjones428:

A faculty headshot of Ashley Jones.