Jump to content

Technical Writing in the Digital Age: Difference between revisions

Went through the whole article and modified grammatical errors and sentence structure. Some examples are: Made the first sentence under "clear and concise" less awkward. Under "graphical," replaced elucidate with explain. Under "keywords," I tried to make the 3rd sentence a little more clear and less awkward. Under "remote collaboration," added closing quotation marks to the first sentence. There were some other things as well, and I am sure I missed some!
m (→‎Pedagogical Approaches: Corrected the page reference for Carroll.)
(Went through the whole article and modified grammatical errors and sentence structure. Some examples are: Made the first sentence under "clear and concise" less awkward. Under "graphical," replaced elucidate with explain. Under "keywords," I tried to make the 3rd sentence a little more clear and less awkward. Under "remote collaboration," added closing quotation marks to the first sentence. There were some other things as well, and I am sure I missed some!)
Line 15: Line 15:
Joseph P. Chapline is considered to be one of the first technical writers, having written in 1949 the first ever user manual for the Binary Automatic Computer (BINAC), an early personal computer.{{sfn|Malone|2008}} In the 1950s, technical writing as a distinct profession began to take shape when technical writers founded formal organizations, academic programs, and conferences dedicated to the art. One of these key writing associations was the Association of Technical Writers and Editors, also formed in the 1950s. Several of these groups eventually merged, forming the Society of Technical Communication in 1960.{{sfn|Malone|2011|pp=285-306}}
Joseph P. Chapline is considered to be one of the first technical writers, having written in 1949 the first ever user manual for the Binary Automatic Computer (BINAC), an early personal computer.{{sfn|Malone|2008}} In the 1950s, technical writing as a distinct profession began to take shape when technical writers founded formal organizations, academic programs, and conferences dedicated to the art. One of these key writing associations was the Association of Technical Writers and Editors, also formed in the 1950s. Several of these groups eventually merged, forming the Society of Technical Communication in 1960.{{sfn|Malone|2011|pp=285-306}}


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. 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.   
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. 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.{{sfn|Macari|2023}}
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}}
Line 30: Line 30:


==== Detailed ====
==== Detailed ====
Accurate information that is delivered with precision and specificity is essential to providing communication that is unambiguous and free of discrepancies.{{sfn|Smirti|2022}} It is free of errors and inconsistencies.
Accurate information that is delivered with precision and specificity is essential to providing communication that is unambiguous and free of discrepancies.{{sfn|Smirti|2022}} Technical communication should be free of errors and inconsistencies.


==== Objective ====
==== Objective ====
Line 36: Line 36:


===== Clear and Concise =====
===== Clear and Concise =====
Technical communication needs to be organized logically, is not unnecessarily involved, and is easily understood by the target audience. The language used should avoid needless jargon and be written in a straightforward manner that avoids redundant word usage and/or excessive explanations.{{sfn|Smirti|2022}}{{sfn|Proofed Editors|2020}}
Technical communication should be logically organized, straightforward, and easily understood by the target audience. The language used should avoid needless jargon and be written in a manner that avoids redundant word usage and/or excessive explanations.{{sfn|Smirti|2022}}{{sfn|Proofed Editors|2020}}


=== Soundness ===
=== Soundness ===
Line 44: Line 44:


==== Graphical ====
==== Graphical ====
Technical communication utilizes visuals strategically to facilitate understanding of textual content. Visuals such as diagrams, charts, graphs, or images can enhance understanding of a technical document. When presented properly, they can elucidate difficult concepts and make material accessible to a more diverse audience.{{sfn|AI and the LinkedIn Community|2023}}
Technical communication utilizes visuals strategically to facilitate understanding of textual content. Visuals such as diagrams, charts, graphs, or images can enhance understanding of a technical document. When presented properly, visuals can explain difficult concepts and make material accessible to a more diverse audience.{{sfn|AI and the LinkedIn Community|2023}}


=== Appropriateness ===  
=== Appropriateness ===  
Line 55: Line 55:


==Personas in Digital Writing==
==Personas in Digital Writing==
Personas in the context of digital writing, which is writing composed, created and read in digital environments, refer to semi-fictional characters that encapsulate the characteristics, behaviors, and needs of target audience segments. They align closely with the principles of user-centered design (UCD).{{sfn|Lucas|2023a}}
Personas in the context of digital writing, which is writing composed, created and read in digital environments, refer to semi-fictional characters that encapsulate the characteristics, behaviors, and needs of target audience segments. They align closely with the principles of user-centered design (UCD).{{sfn|Lucas|2023a}} There are myriad ways to integrate user-centered thinking into the creative process of UX design, and personas are one of the most effective ways to empathize with and analyze users.{{sfn|Goltz|2014}}
There are myriad ways to integrate user-centered thinking into the creative process of UX design, and personas are one of the most effective ways to empathize with and analyze users.{{sfn|Goltz|2014}}


Personas may guide the creation of documentation and tutorials catering to different user needs. It is crucial to adjust the language and tone to match the persona preference. Different personas can influence and guide the design of the project.  
Personas may guide the creation of documentation and tutorials catering to different user needs. It is crucial to adjust the language and tone to match the persona preference. Different personas can influence and guide the design of the project.  


==Rhetorical Strategies in the Digital Age==
==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.{{sfn|Gagich|Zickel|n.d.|pp=34-37}}
[https://en.wikipedia.org/wiki/Rhetoric Rhetoric] is a communication strategy whose primary goal is to persuade an audience. It is grounded in three foundational concepts first defined by the Greek philosopher Aristotle. These concepts are ''logos'', which engages with the reader’s sense of logic or reason; ''pathos'', which appeals to the reader’s emotions; and ''ethos'', which addresses the audience’s values and the writer’s credibility. Within this framework, writers utilize specific techniques or devices to influence and engage readers. Examples include appealing to an audience’s sense of logic by using factual examples to support a point or evoking emotion through descriptive visual language.{{sfn|Gagich|Zickel|n.d.|pp=34-37}}


In today’s digital age, writers can use digital technologies as rhetorical devices to influence the reader. Electronic images and informational graphics can be incorporated into digital and online documents to illustrate or reinforce points made in the text.{{sfn|Markel|Selber|2019}} Hyperlinks can provide access to additional information that supports authors’ ideas and enhances their credibility.{{sfn|Lucas|2023g|}} Nevertheless, the writer's basic task of informing and persuading an audience is the same in digital communication as in other forms of writing.{{sfn|DeVoss|National Writing Project|Eidman-Aadahl|Hicks|2010|p=105}}
In today’s digital age, writers can use digital technologies as rhetorical devices to influence the reader. Electronic images and informational graphics can be incorporated into digital and online documents to illustrate or reinforce points made in the text.{{sfn|Markel|Selber|2019}} Hyperlinks can provide access to additional information that supports authors’ ideas and enhances their credibility.{{sfn|Lucas|2023g|}} Nevertheless, the writer's basic task of informing and persuading an audience is the same in digital communication as in other forms of writing.{{sfn|DeVoss|National Writing Project|Eidman-Aadahl|Hicks|2010|p=105}}
Line 73: Line 72:


====Content Management Systems (CMS)====
====Content Management Systems (CMS)====
A content management system (CMS) is a software application that allows users to create, manage, and modify digital content on a website. It provides a user-friendly interface and tools to easily organize, publish, and update content, including text, images, videos, and documents. Additionally, CMSs often offer features like user permissions, version control, and Search Engine Optimization (SEO) to enhance the overall website management experience.{{sfn|Carroll|2006|p=129}}
A content management system (CMS) is a software application that allows users to create, manage, and modify digital content on a website. It provides a user-friendly interface and tools to easily organize, publish, and update content, including text, images, videos, and documents. Additionally, CMSs often offer features like user permissions, version control, and Search Engine Optimization (SEO) to enhance the overall website management experience.{{sfn|Carroll|2006|p=129}} Some popular examples of CMS include [https://wordpress.com/ WordPress], [https://www.wix.com/ Wix], and [https://www.blogger.com/about/?bpli=1 Blogger].
Some popular examples of CMS include [https://wordpress.com/ WordPress], [https://www.wix.com/ Wix], and [https://www.blogger.com/about/?bpli=1 Blogger].


====Image Processing Software====
====Image Processing Software====
Line 154: Line 152:


===Keywords===
===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.{{sfn|Lucas|2023b}} To optimize a website's keywords, you should begin with researching keywords on your own website and ensure that you have an XML [https://en.wikipedia.org/wiki/Sitemaps sitemap] so search 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.{{sfn|Lucas|2023b}}
Keywords are the words that search engines crawl a website for and index as the page's most important words. Based on other pages using the same keywords, the website is added into the search engine results pages from best matches to worst matches. The position of a website in search results is influenced by where it ranks on a scale determined by the keywords that a user searches for.{{sfn|Lucas|2023b}} To optimize a website's keywords, you should begin with researching keywords on your own website and ensure that you have an XML [https://en.wikipedia.org/wiki/Sitemaps sitemap] so search 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.{{sfn|Lucas|2023b}}


===Alt-Text===
===Alt-Text===
Line 160: Line 158:


===Social Media Presence===
===Social Media Presence===
Sharing content from a website across different social media platforms is another way to create SEO optimization. This technique can help with being seen as legitimate and improves visibility of the website overall. Additionally it can drive traffic and enables back-linking to occur when other websites have the ability to also link to the website.{{sfn|Lucas|2023b}}
Sharing content from a website across different social media platforms is another way to create SEO optimization. This technique can help with being seen as legitimate and improves visibility of the website overall. Additionally, it can drive traffic and enables back-linking to occur when other websites have the ability to also link to the website.{{sfn|Lucas|2023b}}


=== Goals of Searching: The User's Perspective===
=== Goals of Searching: The User's Perspective===
A user of search engines formulates queries by using keywords or posing questions. One of the most important elements of building an SEO strategy for a website is developing a thorough understanding of the psychology of your target audience, and how they use words and concepts to obtain information about the services and/or products you provide. Once you understand how the average search engine user—and, more specifically, your target audience—utilizes query-based search engines, you can more effectively reach and keep those users.{{sfn|Enge|Spencer|Stricchiola|2022|p=9}}
A user of search engines formulates queries by using keywords or posing questions. One of the most important elements of building an SEO strategy for a website is developing a thorough understanding of the psychology of your target audience and how they use words and concepts to obtain information about the services and/or products you provide. Once you understand how the average search engine user—and, more specifically, your target audience—utilizes query-based search engines, you can more effectively reach and keep those users.{{sfn|Enge|Spencer|Stricchiola|2022|p=9}}


==Digital Documentation ==
==Digital Documentation ==
Line 171: Line 169:


====Electronic Format ====
====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.{{sfn|Lucas|2023c}} Digital documentation is the only method to meet a critical challenge of the relatively new concept of "knowledge management" that applies to all organizations. A digital knowledge management system is crucial to an organization so everyone can access information created by employees who are no longer with the organization or cross-referencing with other seemingly unrelated departments.{{sfn|IBM}}
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.{{sfn|Lucas|2023c}} Digital documentation is the only method to meet a critical challenge of the relatively new concept of "knowledge management" that applies to all organizations. A digital knowledge management system is crucial to an organization so everyone can access information created by employees who are no longer with the organization or to allow cross-referencing with other seemingly unrelated departments.{{sfn|IBM}}


====Non-Tangible====
====Non-Tangible====
Line 177: Line 175:


====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.{{sfn|WAI|2022}} It is a legal requirement to include accessibility features in website design.{{sfn|WCAG|2023}} 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|pp=103-104}}
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|WCAG|2023}} 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|pp=103-104}}


====Readability====
====Readability====
Line 183: Line 181:


====Scannability====
====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}} Ways to improve a document's scannability include visual elements, white space, concise language, and highlighting and emphasis.
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}} Ways to improve a document's scannability include implementing visual elements, white space, concise language, highlighting, and emphasis.


====Ease of Reproduction and Distribution====
====Ease of Reproduction and Distribution====
Line 198: Line 196:


====Remote Collaboration====
====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.{{sfn|Lucas|2021}} 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.
One form of collaborative technical writing is a wiki, which is a "website developed collaboratively by a community of users, allowing any user to add and edit content."{{sfn|Lucas|2021}} 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====
====Security Measures====