32
edits
Technical Writing in the Digital Age: Difference between revisions
Technical Writing in the Digital Age (view source)
Revision as of 22:57, 31 October 2023
, 7 months ago→Historical Context: Added info about early technical writer Joseph D. Chapline. Added citation and bib entry for new source. Reworded some of subsequent paragraph so it flowed better.
(Citation edit.) |
(→Historical Context: Added info about early technical writer Joseph D. Chapline. Added citation and bib entry for new source. Reworded some of subsequent paragraph so it flowed better.) |
||
| Line 32: | Line 32: | ||
==Historical Context== | ==Historical Context== | ||
===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 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=harv }}.</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> | |||
==Digital Technologies and Technical Writing== | == Digital Technologies and Technical Writing== | ||
With the rise of digital technology, technical writing has had to adapt to the needs of a digital era. However, many aspects of effective technical writing, such as remaining clear, concise, complete, and correct, still need to be applied to technical writing created for digital interfaces. <ref>Carroll, Brian. ''Writing for Digital Media''. Routledge. New York, 2010. p.24.</ref> | With the rise of digital technology, technical writing has had to adapt to the needs of a digital era. However, many aspects of effective technical writing, such as remaining clear, concise, complete, and correct, still need to be applied to technical writing created for digital interfaces. <ref>Carroll, Brian. ''Writing for Digital Media''. Routledge. New York, 2010. p.24.</ref> | ||
| Line 57: | Line 57: | ||
==Online Documentation and User Experience== | ==Online Documentation and User Experience== | ||
=== Digital Documentation === | ===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.<ref name=":2">Lucas, Gerald (September 1, 2023). “Exploring the Dichotomy: A Comparative Analysis of Digital and Paper Documents.” Retrieved Oct 29, 2023. https://grlucas.net/grl/CompFAQ/Digital_Writing/Documents</ref> | 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.<ref name=":2">Lucas, Gerald (September 1, 2023). “Exploring the Dichotomy: A Comparative Analysis of Digital and Paper Documents.” Retrieved Oct 29, 2023. https://grlucas.net/grl/CompFAQ/Digital_Writing/Documents</ref> | ||
=== Characteristics of Digital Documents === | === Characteristics of Digital Documents=== | ||
==== Accessibility ==== | ====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.<ref>{{cite web |url=https://www.w3.org/WAI/fundamentals/accessibility-intro/ |title=Introduction to Web Accessibility |author=<!--Not stated--> |website=Web Accessibility Initiative |access-date=October 26, 2023 }}</ref> It is a legal requirement to include accessibility features in website design.<ref>{{cite web |url=https://wcag.com/legal/ |title=Accessibility and the Web |author=<!--Not stated--> |website=WCAG |access-date=October 26, 2023 }}</ref> | 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.<ref>{{cite web |url=https://www.w3.org/WAI/fundamentals/accessibility-intro/ |title=Introduction to Web Accessibility |author=<!--Not stated--> |website=Web Accessibility Initiative |access-date=October 26, 2023 }}</ref> It is a legal requirement to include accessibility features in website design.<ref>{{cite web |url=https://wcag.com/legal/ |title=Accessibility and the Web |author=<!--Not stated--> |website=WCAG |access-date=October 26, 2023 }}</ref> | ||
==== Readability ==== | ==== 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> | 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> | ||
==== Scannable ==== | ====Scannable==== | ||
Readers quickly scan the main sections of a page to understand its content. 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.<ref>Barr, Chris (2010). Yahoo! Style Guide. New York: St. Martin's. p8.</ref> | Readers quickly scan the main sections of a page to understand its content. 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.<ref>Barr, Chris (2010). Yahoo! Style Guide. New York: St. Martin's. p8.</ref> | ||
==== Hyperlinking ==== | ====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.<ref name=":1" /> | 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.<ref name=":1" /> | ||
=== 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. | 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 ==== | ||
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 | 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. | | last1 = Lannon | first1 = John M. | ||
| Line 88: | Line 88: | ||
| isbn = 978-0-13-520322-4}}</ref> | | isbn = 978-0-13-520322-4}}</ref> | ||
==== 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. | 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 | <ref>{{cite book | ||
| Line 97: | Line 97: | ||
| pages = Chapter 4. PowerPoint Tips, Tricks, and Secrets | | pages = Chapter 4. PowerPoint Tips, Tricks, and Secrets | ||
| date = 2018}}</ref> | | date = 2018}}</ref> | ||
==Collaboration and Version Control== | ==Collaboration and Version Control== | ||
=== Collaboration === | ===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>Lucas, Gerald (18 May 2021). "Writing on a Wiki". Retrieved 2023-10-31.</ref> | 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>Lucas, Gerald (18 May 2021). "Writing on a Wiki". Retrieved 2023-10-31.</ref> | ||
=== Version Control === | ===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" /> | 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" /> | ||
==Ethical Considerations== | ==Ethical Considerations == | ||
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> | 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> | ||
| Line 124: | Line 119: | ||
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> | 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> | ||
=== Disinformation === | ===Disinformation=== | ||
One major ethical concern in all forms of writing, but especially in digital writing, is the creation and spread of disinformation. Disinformation, often referred to as "[[w:Fake news|fake news]]," is information that is purposefully spread as false or misleading and is a sub-type of misinformation.<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. | 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>Balzotti, Jon (2022). ''Technical Communication: A Design-Centric Approach''. New York. Routledge. p. 18. ISBN 978-1-003-00606-0</ref> | 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>Balzotti, Jon (2022). ''Technical Communication: A Design-Centric Approach''. New York. Routledge. p. 18. ISBN 978-1-003-00606-0</ref> | ||
==Pedagogical Approaches== | == 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> | 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> | ||
| Line 136: | Line 131: | ||
==Future Trends and Challenges== | ==Future Trends and Challenges== | ||
=== Challenge === | ===Challenge=== | ||
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> | 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> | ||
=== Artificial Intelligence === | ===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 | 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 | | 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 | ||