Technical Writing in the Digital Age: Difference between revisions
Beth Kennedy (talk | contribs) (→Case Studies: Added definition) |
Debbiebwolfe (talk | contribs) (Added definition and citation.) |
||
Line 20: | Line 20: | ||
==== 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=}} | |||
==== 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}} | ||
Line 268: | Line 268: | ||
* {{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 }} | * {{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 }} | ||
* {{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=2014 |website=smashingmagazine.com |publisher=Smashing Media AG |access-date=2023-11-13 }} | * {{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=2014 |website=smashingmagazine.com |publisher=Smashing Media AG |access-date=2023-11-13 }} | ||
* {{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 }} | * {{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 }} | ||
* {{cite web |url=https://www.idassoc.com/product-information-definition/data-sheet |title=Product Information Encyclopedia |last=IDA |first= |date=2020 |website=Industrial Data Associates |publisher= |access-date=2023-11-20 |quote= |ref=harv }} | |||
* {{cite book |last=Johnson-Sheehan |first=Richard |title=Technical Communication Today |url= |edition=6 |chapter=Chapter 4: Managing Ethical Challenges |location=Boston, MA |publisher=Pearson |date=2018 |pages=71-98 }} | * {{cite book |last=Johnson-Sheehan |first=Richard |title=Technical Communication Today |url= |edition=6 |chapter=Chapter 4: Managing Ethical Challenges |location=Boston, MA |publisher=Pearson |date=2018 |pages=71-98 }} | ||
* {{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 }} | * {{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 }} |
Revision as of 14:53, 20 November 2023
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. Its purview encompasses the creation, dissemination, and management of technical documents and content within an expansive digital landscape.
Major considerations 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. 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. 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.
Overview
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. [1]
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. [2] 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.
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.[3]
Common types of technical communication include:[4]
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. [5]
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. [6]
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.[7] Emails should be brief, concise, readable, and targeted to specific audiences with specific subject lines.[8]
Instructions & Procedures
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. [9]
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. [10]
Press Releases
Proposals
Reports
Resumes
User guides
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. [11]
Accuracy
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. Furthermore, many organizations may have a style guide that outlines preferred language usage, tone, and formatting. [11]
Detailed
Accurate information that is delivered with precision and specificity is essential to providing communication that is unambiguous and free of discrepancies. [11] It is free of errors and inconsistencies.
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 where accuracy and impartiality are essential. [12]
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. [11] [13]
Soundness
Formatted and Organized
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. Formatting detail should remain consistent throughout the document. [11] [13]
Graphical
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. [14]
Appropriateness
Audience-specific
Where possible, technical communication should be customized to align with the knowledge and needs of its audience. Communication style and tone should be tailored to match the audience's level of expertise and should take into consideration such factors as the the users' technical background, familiarity with the subject, and specific requirements. [15]
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.[16] 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.[17]
The need for paperwork ushered in by World War II served as the driving force for the technical writing profession in the United States. [18] This was a time years before the computer and photocopier became common office equipment. During this period, the role of the technical writer revolved solely around words, and their primary work tools consisted of either a pencil or ink pen and paper. The technical writer would draft the document by hand, and a typist or clerical worker would then use a typewriter to transfer the writer's words into a finished document.
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. [19]
The projects of today's technical writers can be as varied as writing instructions to assemble a living room chair to creating websites. [20] 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. [20]
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 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 thus, it can be accessed by anyone with access to the internet. Such a phenomenon can be exploited to increase the audience of a virtual document.
There are several web-based tools and techniques which allow digital documents to be more easily shared. Online word processors such as Google Docs and SharePoint allow documents to be readily disseminated. Comment capability allows audience members to interact about a document with one another as well as with the document author. Relationships created by such online interaction fosters an environment whereby online authors might choose to link the works of various others to their own personal websites. 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. [21]
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).[22] 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.[23]
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. [24]
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.[1] 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.[25]
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.[26]
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.[27] 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. [28]
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.[27] To optimize a website's keywords, you should begin with researching keywords on your own website and ensure that you have an XML sitemap so search engine's such as 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.[27]
Using Alt-Text
Alt-Text (alternative text), or 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.[27]
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.[27]
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.[29]
Characteristics of Digital Documents
Electronic Format
Digital documents exist in electronic formats, which means they are stored and transmitted as binary data. This format allows for efficient storage, retrieval, and transmission of information via electronic devices.[30]
Non-Tangible
Unlike paper documents, digital documents lack physical presence. They are intangible and exist as electronic files, residing on devices or in the cloud.[30]
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.[31] It is a legal requirement to include accessibility features in website design.[32] There are four different types of impairment that can affect how a user interacts and perceives digital documents: vision, mobility, auditory, and cognitive.[33]Digital documents will need to be optimized so that information can be accessed by hardware and software tools used by people with disabilities.[34]
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.[35] The other four Cs are coherent, concrete, correct and complete.[36]
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.[37] 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. [38]
Ease of Reproduction and Distribution
Digital documents are easily copied and distributed. They can be duplicated without any loss of quality, making it simple to share information widely and at minimal cost.[30]
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.[39]
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.[40] Increasing multimodality on a website improves engagement, usability, and accessibility. This can improve the impact of the website's standings in SERPs.[41]
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.[42]
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.[43] 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.
Security Measures
Digital documents can be protected with encryption, passwords, and access controls to safeguard sensitive information. These security measures enhance data protection and privacy.[30]
Environmental Impact
Digital documents have a smaller environmental footprint compared to paper documents, as they reduce the need for paper production, printing, and transportation.[30]
Dynamic Updates
Online digital documents can be updated dynamically, ensuring that users always have access to the most current information. This is particularly valuable in fast-changing fields.[30]
Global Accessibility
Digital documents can be shared globally, transcending geographical boundaries and time zones. They support international collaboration and the dissemination of knowledge on a global scale.[30]
Data Integration
In business and research settings, digital documents can integrate with databases and data analysis tools. This integration streamlines data collection, analysis, and reporting processes.[30]
Data Analytics
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.[30]
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. [44]
Presentations
Presentations created with PowerPoint or 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.[45]
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.[46] 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.[47]
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. [48]
User-Centered Design
The approach of user-centered design (UCD) in technical writing consists of the following methodology[49]:
User Research
User research is the act of conducting thorough research through surveys, interviews, and usability testing to gain a better understanding of user needs and experiences when using a digital document.
Ideation and Prototyping
Ideation and prototyping refers to the process of creating digital designs and prototypes to assist with exploring possible solutions to meet user needs.
Usability Testing
Usability testing refers to the act of having users interact with digital document designs and recording and adjusting the design based on user feedback.
Implementation
Implementation is the stage in which the design is implemented after making adjustments from prior testing.
Evaluation
Evaluation refers to the stage in which the digital document is assessed to ensure that it is meeting user needs.
Maintenance and Updates
Maintenance and updates are required in order to maintain a digital document based on user feedback and changing needs.
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.[50]
The Society for Technical Communication (STC) is the world's oldest professional association dedicated to advancing the field of technical communication.[51] The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.[51]
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.[41]
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.[52]
The Employer
Obligations to one's employer include competence and diligence, honesty and candor, confidentiality, and loyalty.[52] 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.[53]
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.[52]
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.[52] 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.[54]
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 "fake news," is information that is purposefully spread as false or misleading and is a sub-type of misinformation.[55] 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.[56] 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.[53]
Pedagogical Approaches
Barriers to teaching technical communications include the speed at which digital tools evolve and the complexity of software. [57]
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.[41]
Future Trends and Challenges
Future Trends
Between 2022 and 2032, the United States Bureau of Labor Statistics is projecting a 7% job growth for technical writers. [58]
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.[59] 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.[59]
Artificial Intelligence
Artificial intelligence programs, utilizing natural language processing, are capable of producing technical writing and have advanced in recent years becoming more adept.[60]
One such program is ChatGPT, which uses machine learning to produce texts with human-like style and tone. [61] Another leader in this area, Contentbot, uses a WordPress plugin which gives blog writers ideas to enhance their posts which are shared via email.[62]
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. [63] 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 Business Insider, writing jobs are among the top 10 roles that AI is most likely to replace. [64]
References
Citations
- ↑ 1.0 1.1 Markel & Selber 2019.
- ↑ Perelman 1998.
- ↑ Lannon & Gurak 2020, p. 32.
- ↑ Mussack 2021.
- ↑ Johnson-Sheehan 2018, p. 401-404.
- ↑ IDA 2020.
- ↑ Lannon & Gurak 2020, p. 335.
- ↑ Lannon & Gurak 2020, p. 348.
- ↑ Johnson-Sheehan 2018, p. 139.
- ↑ Lannon & Gurak 2020, p. 353.
- ↑ 11.0 11.1 11.2 11.3 11.4 Smirti 2022.
- ↑ Rachel Detweiler 2021.
- ↑ 13.0 13.1 Proofed Editors 2020.
- ↑ AI and the LinkedIn Community 2023.
- ↑ Viral Nation 2019.
- ↑ Malone 2008.
- ↑ Malone 2011, pp. 285-306.
- ↑ Rathbone 1958.
- ↑ Macari 2023.
- ↑ 20.0 20.1 Grimstead 1999.
- ↑ Carroll 2010, p. 24.
- ↑ Lucas 2023a.
- ↑ Goltz 2014.
- ↑ Gagich & Zickel n.d., pp. 34-37.
- ↑ DeVoss et al. 2010, p. 105.
- ↑ Lawrence 2022, pp. 6-14.
- ↑ 27.0 27.1 27.2 27.3 27.4 Lucas 2023b.
- ↑ Barr 2010, chpt. 17.
- ↑ Lucas 2014.
- ↑ 30.0 30.1 30.2 30.3 30.4 30.5 30.6 30.7 30.8 Lucas 2023c.
- ↑ WAI 2022.
- ↑ WCAG 2023.
- ↑ Robbins 2018, p. 42.
- ↑ Barr 2010, pp. 103-104.
- ↑ Zeleznik, Burnett & Benson 1999, p. 207.
- ↑ Last 2019.
- ↑ Krug 2014, p. 23.
- ↑ Barr 2010, p. 103.
- ↑ Carroll 2010, p. 79.
- ↑ Carroll 2010, p. 36.
- ↑ 41.0 41.1 41.2 Carroll 2010, p. 280.
- ↑ Lucas 2023d.
- ↑ Lucas 2021.
- ↑ Lannon & Gurak 2020, pp. 292-293.
- ↑ Parkinson 2018, chpt. 4.
- ↑ Bair 2014, p. 7.
- ↑ Rose & Garret 2012, p. 2.
- ↑ Garrett 2011, p. 17.
- ↑ Lucas 2023e.
- ↑ Johnson-Sheehan 2018, pp. 71-84.
- ↑ 51.0 51.1 STC 2023.
- ↑ 52.0 52.1 52.2 52.3 Markel 2009.
- ↑ 53.0 53.1 Balzotti 2022, p. 83.
- ↑ EPA 2023.
- ↑ Lawrence 2022, section 3.7.
- ↑ Lucas 2023f.
- ↑ Hovde 2017, pp. 395-411.
- ↑ United States Bureau of Labor Statistics 2023.
- ↑ 59.0 59.1 Ajose-Coker 2022.
- ↑ Marr 2023.
- ↑ University of Central Arkansas 2023.
- ↑ Siddiqui 2022.
- ↑ Klein 2023.
- ↑ Mok 2023.
Bibliography
- AI and the LinkedIn Community (2023). "How Can You Create Effective Visual Aids for Technical Writing?". www.linkedin.com. LinkedIn. Retrieved 2023-11-05.CS1 maint: ref=harv (link)
- Ajose-Coker, Dipo (2022). "Common Problems in Technical Writing and How to Solve Them". componize.com. Componize Software. Retrieved 2023-11-19.
- Bair, Amy Lupold (2014). Blogging for Dummies. Hoboken, NJ: Jon Wiley & Sons, Inc.CS1 maint: ref=harv (link)
- Balzotti, Jon (2022). Technical Communication: A Design-Centric Approach. New York: Routledge. p. 83.
- Barr, Chris (2010). The Yahoo! Style Guide. New York: St. Martin's.
- Carroll, Brian (2010). Writing for Digital Media. New York: Routledge.
- University of Central Arkansas. "Chat GPT: What is it?". uca.edu. University of Central Arkansas. Retrieved 2023-10-09.
- Detwiler, Rachel (2021). "Objectivity in Technical Writing". www.betonconsultingeng.com. Beton Consulting Engineers L.L.C. Retrieved 2023-11-05.CS1 maint: ref=harv (link)
- DeVoss, Danielle; National Writing Project; Eidman-Aadahl, Elyse; Hicks, Troy (2010). Because Digital Writing Matters: Improving Student Writing in Online and Multimedia Environments. San Francisco: Jossey-Bass. p. 105.
- "Criminal Provisions of the Resource Conservation and Recovery Act (RCRA)". United States Environmental Protection Agency. 2023.
- Gagich, Melanie; Zickel, Emilie (n.d.). "Rhetorical Appeals: Logos, Pathos, and Ethos Defined". Writing Arguments in Stem. Digital Commons. pp. 34–37.
- Garrett, Jesse James (2011). The Elements of User Experience: User-Centered Design for the Web and Beyond (2nd ed.). Berkeley, CA: New Riders. p. 17.
- Goltz, Shlomo (2014). "A Closer Look at Personas: A Guide to Developing The Right Ones (Part 2)". smashingmagazine.com. Smashing Media AG. Retrieved 2023-11-13.
- Grimstead, Deborah M. (1999). "Technical Writers are in Demand: Do You Have The Right Stuff?". Black Collegian. p. 128.
- IDA (2020). "Product Information Encyclopedia". Industrial Data Associates. Retrieved 2023-11-20.CS1 maint: ref=harv (link)
- Johnson-Sheehan, Richard (2018). "Chapter 4: Managing Ethical Challenges". Technical Communication Today (6 ed.). Boston, MA: Pearson. pp. 71–98.
- Klein, Alyson (2023). "ChatGPT Cheating: What to Do When It Happens". Education Week. Bethesda, MD. Retrieved 2023-11-05.
- Krug, Steve (2014). Don’t Make Me Think, Revisited. Berkeley, CA: New Riders.
- Lannon, John M.; Gurak, Laura J. (2020). Technical Communication (15 ed.). Pearson Education.
- Last, Susan (2019). Technical Writing Essentials. Victoria, B.C. University of Victoria.
- Lawrence, Dan (2022). Digital Writing: A Guide to Writing for Social Media and the Web. Peterborough, Ontario, Canada: Broadview Press. p. 85.
- Lucas, Gerald (2021). "Writing on a Wiki". grlucas.net. MediaWiki. Retrieved 2023-10-31.
- Lucas, Gerald (2023a). "Using Personas in Digital Writing". grlucas.net. MediaWiki. Retrieved 2023-11-07.
- Lucas, Gerald (2023b). "Search Engine Optimization: Strategies and Best Practices for Effective Online Visibility". grlucas.net. MediaWiki. Retrieved 2023-11-19.
- Lucas, Gerald (2023c). "Exploring the Dichotomy: A Comparative Analysis of Digital and Paper Documents". grlucas.net. MediaWiki. Retrieved 2023-10-29.
- Lucas, Gerald (2023d). "User-Centered Design in Digital Documents". grlucas.net. MediaWiki. Retrieved 2023-11-15.
- Lucas, Gerald (2023e). "Audience-Centric Style in Digital Writing". grlucas.net. MediaWiki. Retrieved 2023-10-22.
- Macari, Sabina (2023). "What Does a Technical Writer Do? (Plus How To Become One)". indeed.com. Indeed. Retrieved 2023-11-05.
- Malone, Ed (2008). "Joseph D. Chapline: Technical Communication's Mozart" (PDF). IEEE Professional Communication Society Newsletter. Retrieved 2023-10-31.
- Malone, Edward (November 2011). "The First Wave (1953-1961) of the Professionalization Movement in Technical Communication" (PDF). Technical Communication. 58 (4): 285–306. Retrieved 2023-10-11.
- Markel, Michael (2009). Technical Communication (9th ed.). Boston: Bedford/St. Martin's. pp. 22–25.
- Markel, Mike; Selber, Stuart A. (2019). Practical Strategies of Technical Communication (3rd ed.). Boston: Bedford/St. Martin’s.
- Marr, Bernard (2023). "How ChatGPT And Natural Language Technology Might Affect Your Job If You Are A Computer Programmer". Forbes.com. Forbes Media. Retrieved 2023-10-31.
- Mok, Aaron (2023). "ChatGPT may be coming for our jobs. Here are the 10 roles AI is most likely to replace". Insider. Business Insider. Retrieved 2023-11-05.
- Mussack, Brigitte (2021). Introduction to Technical and Professional Communication. Creative Commons Attribution NonCommercial. pp. n.p.
- Parkinson, Mike (2018). "Chapter 4. PowerPoint Tips, Tricks, and Secrets". A Trainer’s Guide to PowerPoint: Best Practices for Master Presenters. United States: Association for Talent Development.
- Perelman, Leslie (1998). The Mayfield Handbook of Technical and Scientific Writing. Mountain View: Mayfield Publishing Company. pp. n.p.
- Proofed Editors (2020). "A Beginner's Guide to Technical Writing". Proofed.com. Proofed. Retrieved 2023-11-05.CS1 maint: ref=harv (link)
- Rathbone, Robert (1958). "Growth of the technical writing profession". STWE Review. 5 (1): 5–16.
- Rose, Darren; Garret, Chris (2012). ProBlogger: Secrets for Blogging Your Way to a Six-Figure Income. Indianapolis, IN: Jon Wiley & Sons, Inc.CS1 maint: ref=harv (link)
- Robbins, Jennifer Niederst (2018). Learning Web Design: A Beginner’s Guide to HTML, CSS, JavaScript, and Web Graphics (5th ed.). Sebastopol, CA: O’Reilly Media, Inc.
- Siddiqui, Zafar (2022). "Will Best Artificial Intelligence Take Over any Technical Content Writer?". writingcooperative.com. The Writing Cooperative. Retrieved 2023-11-19.
- Smirti (2022). "Features of Technical Communication". managementnote.com. Management Note. Retrieved 2023-11-05.
- Society for Technical Communication (2023a). "About STC". stc.org. Retrieved 2023-10-27.
- Society for Technical Communication (2023b). "Ethical Principles". stc.org. Retrieved 2023-10-27.
- United States Bureau of Labor Statistics (2023). "Occupational Outlook Handbook". bls.gov. United States Department of Labor. Retrieved 2023-11-07.
- University of Central Arkansas. "Chat GPT: What is it?". uca.edu. University of Central Arkansas. Retrieved 2023-10-09.
- Viral Nation (2019). "What is Digital Content Creation? (and How Can It Help Me as a Marketing Manager)". viralnation.com. Viral Nation. Retrieved 2023-11-05.CS1 maint: ref=harv (link)
- WAI (2022). "Introduction to Web Accessibility". W3.org. Retrieved 2023-10-26.
- WCAG (2023). "Accessibility and the Law". wcag.com. eSSENTIAL Accessibility. Retrieved 2023-10-26.
- Zeleznik, J. M.; Burnett, R. E.; Benson, P. J. (1999). Technical Writing: What It Is and How to Do It. National Book Network. p. 107.