339
edits
Technical Writing in the Digital Age: Difference between revisions
Technical Writing in the Digital Age (view source)
Revision as of 09:42, 2 December 2023
, 5 months agoProtected "Technical Writing in the Digital Age": Protected for evaluation. ([Edit=Allow only administrators] (expires 13:42, 9 December 2023 (UTC)) [Move=Allow only administrators] (expires 13:42, 9 December 2023 (UTC)))
Ebyington3 (talk | contribs) (→Bibliography: added reference) |
m (Protected "Technical Writing in the Digital Age": Protected for evaluation. ([Edit=Allow only administrators] (expires 13:42, 9 December 2023 (UTC)) [Move=Allow only administrators] (expires 13:42, 9 December 2023 (UTC)))) |
||
| (25 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
[[File:Digital writing.jpg|thumb|Book cover for "Digital Writing" by Dan Lawrence]] | |||
'''Technical Writing in the Digital Age''' represents the dynamic and evolving discipline of creating written, visual, and interactive materials that convey complex information, instructions, and technical concepts in the context of contemporary digital technologies. | '''Technical Writing in the Digital Age''' represents the dynamic and evolving discipline of creating written, visual, and interactive materials that convey complex information, instructions, and technical concepts in the context of contemporary digital technologies. | ||
Technical writing is a specialized skill that requires technical knowledge and well-developed communication skills. It involves explaining complex information in a clear, concise, and accessible manner. Through the evolution of technologies like the Internet and smartphones, technical writing has evolved from traditional printed formats to more digital-oriented media. Today, users expect content to be available on various platforms and devices, providing up-to-date information on demand. Technical writers have adapted to these changes by creating compelling, concise, SEO-friendly content in various forms such as infographics, e-books, podcasts, videos, blogs, GIFs, memes, and other interactive content. | Technical writing is a specialized skill that requires technical knowledge and well-developed communication skills. It involves explaining complex information in a clear, concise, and accessible manner. Through the evolution of technologies like the Internet and smartphones, technical writing has evolved from traditional printed formats to more digital-oriented media. Today, users expect content to be available on various platforms and devices, providing up-to-date information on demand. Technical writers have adapted to these changes by creating compelling, concise, SEO-friendly content in various forms, such as infographics, e-books, podcasts, videos, blogs, GIFs, memes, and other interactive content. | ||
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. | 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. Multimodality and the interfacing of multiple media platforms and sources also play a role in digital technical writing. | ||
=='''Overview'''== | =='''Overview'''== | ||
| Line 10: | Line 11: | ||
==='''Importance of Research'''=== | ==='''Importance of Research'''=== | ||
Research plays a vital role in technical writing. The main purposes of research are to inform action, gather evidence for theories, and contribute to developing knowledge in a field of study. {{sfn|Zarah|2023}} Research helps build knowledge and facilitate learning, helps society understand issues and increase public awareness, and aids in supporting truth.{{sfn|Zarah|2023}} Proper research provides a strong foundation for efficient technical writing. | Research plays a vital role in technical writing. The main purposes of research are to inform action, gather evidence for theories, and contribute to developing knowledge in a field of study.{{sfn|Zarah|2023}} Research helps build knowledge and facilitate learning, helps society understand issues and increase public awareness, and aids in supporting truth.{{sfn|Zarah|2023}} Proper research provides a strong foundation for efficient technical writing. | ||
Major decisions are often based upon results from research. Technical communicators often work with subject matter experts | Major decisions are often based upon results from research. Technical communicators often work with subject matter experts but can also conduct in-depth independent research to produce a technical document. The stages of critical thinking in the research process are{{sfn|Lannon|Gurak|2020|p=145}}: | ||
*Asking the right questions. The right questions help define the research problem. The answers found in research are only as good as the questions asked. | *Asking the right questions. The right questions help define the research problem. The answers found in research are only as good as the questions asked. | ||
*Exploring a balance of views. This provides a broad range of ''evidence''. Ask: What do informed sources say about the topic? On which points do sources agree or disagree? Which sources carry more weight than others? | *Exploring a balance of views. This provides a broad range of ''evidence''. Ask: What do informed sources say about the topic? On which points do sources agree or disagree? Which sources carry more weight than others? | ||
| Line 26: | Line 27: | ||
Joseph D. Chapline is considered to be one of the first technical writers, having written in 1949 the first-ever user manual for the Binary Automatic Computer (BINAC), an early personal computer.{{sfn|Malone|2008}} In the 1950s, technical writing as a distinct profession began to take shape when technical writers founded formal organizations, academic programs, and conferences dedicated to the art. One of these key writing associations was the Association of Technical Writers and Editors, also formed in the 1950s. Several of these groups eventually merged, forming the Society for Technical Communication (STC) in 1960.{{sfn|Malone|2011|pp=285-306}} The STC is the world's oldest professional association dedicated to advancing the field of technical communication. The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.{{sfn|Society for Technical Communication|2023}} | Joseph D. Chapline is considered to be one of the first technical writers, having written in 1949 the first-ever user manual for the Binary Automatic Computer (BINAC), an early personal computer.{{sfn|Malone|2008}} In the 1950s, technical writing as a distinct profession began to take shape when technical writers founded formal organizations, academic programs, and conferences dedicated to the art. One of these key writing associations was the Association of Technical Writers and Editors, also formed in the 1950s. Several of these groups eventually merged, forming the Society for Technical Communication (STC) in 1960.{{sfn|Malone|2011|pp=285-306}} The STC is the world's oldest professional association dedicated to advancing the field of technical communication. The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.{{sfn|Society for Technical Communication|2023}} | ||
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 | 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 years before the computer and photocopier became standard 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.{{sfn|Rathbone|1958|p=6}} | ||
Advances in technology thrust the technical writing profession into a new era. The technical writer's work may now include not only text but also images, drawings, and computer-based media. The modern technical writer may also be involved in research and information-gathering, speaking with subject matter experts, and selecting document media and project tools.{{sfn|Macari|2023}} | Advances in technology thrust the technical writing profession into a new era. The technical writer's work may now include not only text but also images, drawings, and computer-based media. The modern technical writer may also be involved in research and information-gathering, speaking with subject matter experts, and selecting document media and project tools.{{sfn|Macari|2023}} | ||
The projects of today's technical writers range from writing instructions to assemble a living room chair to creating websites.{{sfn|Grimstead|1999}} The titles of today's technical writers may vary as well, such as Information Architects or Documentation Specialists.{{sfn|Grimstead|1999}} | The projects of today's technical writers range from writing instructions to assemble a living room chair to creating websites.{{sfn|Grimstead|1999}} The titles of today's technical writers may vary as well, such as Information Architects or Documentation Specialists.{{sfn|Grimstead|1999}} | ||
'''Future Trends''' | |||
Between 2022 and 2032, the [https://en.wikipedia.org/wiki/Bureau_of_Labor_Statistics, United States Bureau of Labor Statistics] is projecting a 7% job growth for technical writers.{{sfn|United States Bureau of Labor Statistics|2023}} | Between 2022 and 2032, the [https://en.wikipedia.org/wiki/Bureau_of_Labor_Statistics, United States Bureau of Labor Statistics] is projecting a 7% job growth for technical writers.{{sfn|United States Bureau of Labor Statistics|2023}} | ||
[[File:Bureau of labor statistics.jpg|Job growth for tech writing projected by the Bureau of Labor Statistics|center|frame]] | |||
=='''Technical Communication Strategies'''== | =='''Technical Communication Strategies'''== | ||
==='''Characteristics of Technical Communication'''=== | ==='''Characteristics of Technical Communication'''=== | ||
Technical communication is meant to guide an audience and must be easily understood. Successful technical documentation is accurate, logically sound, and appropriate.{{sfn|Perelman|1998}} Communication can be | Technical communication is meant to guide an audience and must be easily understood. Successful technical documentation is accurate, logically sound, and appropriate.{{sfn|Perelman|1998}} Communication can be accurate in description and content. Accurate descriptions are easy to understand. Accurate content provides for the intended result. Communication delivered logically is well-organized, clear, and will be coherent for most users. Appropriate technical information contains elements and steps suitable for the intended purpose and audience.{{sfn|Perelman|1998}} | ||
====Standards Compliant==== | ====Standards Compliant==== | ||
| Line 50: | Line 53: | ||
=====Clear and Concise===== | =====Clear and Concise===== | ||
Technical communication should be logically organized, straightforward, and easily understood by the target audience. The language used should avoid needless jargon and be written in a manner that avoids redundant word usage and excessive explanations. | Technical communication includes a well-structured document. Technical communication should be logically organized, straightforward, and easily understood by the target audience. Planning the document structure allows the technical writer to define the purpose, scope, and main points of the document. The language used should avoid needless jargon and be written in a manner that avoids redundant word usage and/or excessive explanations. {{sfn|Proofed Editors|2020}}<ref>[https://www.linkedin.com/advice/0/how-do-you-write-clear-technical-documents-clients-skills-writing#know-your-audience]</ref> | ||
====Formatted and Organized==== | ====Formatted and Organized==== | ||
| Line 62: | Line 65: | ||
====Document Design==== | ====Document Design==== | ||
The appropriateness of documents requires readers to understand the document's message quickly. The document should be of appropriate style and length for the readers' needs. | Plan the structure of a document so that it is easy to follow and understand. Planning the document structure includes defining a purpose, breadth, and main subjects. Organize the document into a logical and clear order that maintains the purpose of the article. Headings, subheadings, and lists provide coherence to a technical paper. <ref>[https://www.linkedin.com/advice/0/how-do-you-write-clear-technical-documents-clients-skills-writing#know-your-audience]</ref> The appropriateness of documents requires readers to understand the document's message quickly. The document should be of appropriate style and length for the readers' needs. | ||
==='''Examples of Technical Documents'''=== | ==='''Examples of Technical Documents'''=== | ||
Technical writing encompasses various genres and styles | Technical writing encompasses various genres and styles influenced by the information and discourse communities. Not all technical documents are produced by technical writers, as many professionals create various technical documents.{{sfn|Lannon|Gurak|2020|p=32}} | ||
Common types of technical communication include:{{sfn|Mussack|2021}} | Common types of technical communication include:{{sfn|Mussack|2021}} | ||
| Line 88: | Line 91: | ||
====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}} | [[File:Email.png|thumb|201x201px|Image of an 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}} | |||
====Letters==== | ====Letters==== | ||
| Line 97: | Line 101: | ||
====Press Releases==== | ====Press Releases==== | ||
A press release can be an announcement or | A press release can be an organization's announcement or latest news distributed to media outlets with information for the public. A press release can be called a press statement, news release, or media release.{{sfn|Pradhan|2021}} | ||
====Proposals==== | ====Proposals==== | ||
| Line 108: | Line 112: | ||
Informal or brief reports provide an objective overview of an organization's current state, past events, and future plans, ensuring that readers are well-informed about the organization's operations. Some examples include{{sfn|Johnson-Sheehan|2018|pp=285-288}}: | Informal or brief reports provide an objective overview of an organization's current state, past events, and future plans, ensuring that readers are well-informed about the organization's operations. Some examples include{{sfn|Johnson-Sheehan|2018|pp=285-288}}: | ||
*Progress | *Progress reports are used to inform management about the progress or status of a project. | ||
* White papers and | * White papers and briefings educate management or clients about important issues. | ||
*Incident | *Incident reports objectively focus on presenting facts relating to an accident or irregular occurrence. | ||
*Laboratory | *Laboratory reports describe experiments, tests, or inspections. | ||
=====Formal Reports===== | =====Formal Reports===== | ||
| Line 126: | Line 130: | ||
Skills resumes provide employment history, but the primary focus is to highlight how an individual applied distinct skills and experiences across various professional positions.{{sfn|Markel|Selber|2019|pp=411-412}} | Skills resumes provide employment history, but the primary focus is to highlight how an individual applied distinct skills and experiences across various professional positions.{{sfn|Markel|Selber|2019|pp=411-412}} | ||
====User | ====User Guides==== | ||
A user guide is an instructional manual created to help consumers use the product, service or system. A user guide typically includes step-by-step instructions.{{Sfn|Wainaina|2022}} | A user guide is an instructional manual created to help consumers use the product, service or system. A user guide typically includes step-by-step instructions.{{Sfn|Wainaina|2022}} | ||
| Line 145: | Line 149: | ||
====Readability==== | ====Readability==== | ||
[[File:Inverted pyramid.jpg|thumb|This pyramid explains how to best display information in a paragraph quickly | [[File:Inverted pyramid.jpg|thumb|From "Writing for the Web" by Lynda Felder: This pyramid explains how to best display information in a paragraph quickly for readability and scannability]] | ||
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.{{sfn|Zeleznik|Burnett|Benson|1999|p=207}} The other four Cs are coherent, concrete, correct and complete.{{sfn|Last|2019}} | 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.{{sfn|Zeleznik|Burnett|Benson|1999|p=207}} The other four Cs are coherent, concrete, correct, and complete.{{sfn|Last|2019}} | ||
====Scannability==== | ====Scannability==== | ||
| Line 158: | Line 162: | ||
====Multimedia==== | ====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.{{sfn|Carroll|2010|p=280}} | 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 search engine results pages (SERPs).{{sfn|Carroll|2010|p=280}} | ||
====Version Control==== | ====Version Control==== | ||
| Line 164: | Line 168: | ||
====Remote Collaboration==== | ====Remote Collaboration==== | ||
One form of collaborative technical writing is a wiki, | One form of collaborative technical writing is a wiki, 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 location. | ||
====Security Measures==== | ====Security Measures==== | ||
| Line 191: | Line 195: | ||
====Presentations==== | ====Presentations==== | ||
[[File:Microsoft powerpoint.png|thumb|Logo for Microsoft PowerPoint]] | |||
Presentations created with [https://en.wikipedia.org/wiki/Microsoft_PowerPoint PowerPoint] or [https://en.wikipedia.org/wiki/Google_Slides Google Slides] are vital for professional communication and knowledge sharing. They condense complex information into visually appealing slides for effective presentations by using photos, videos, graphics, charts, and graphs.{{sfn|Parkinson|2018|loc=chpt. 4}} | Presentations created with [https://en.wikipedia.org/wiki/Microsoft_PowerPoint PowerPoint] or [https://en.wikipedia.org/wiki/Google_Slides Google Slides] are vital for professional communication and knowledge sharing. They condense complex information into visually appealing slides for effective presentations by using photos, videos, graphics, charts, and graphs.{{sfn|Parkinson|2018|loc=chpt. 4}} | ||
====Blogs==== | ====Blogs==== | ||
A blog, short for "weblog," is an informational website organized into short articles called posts, typically chronologically ordered series of website updates | A blog, short for "weblog," is an informational website organized into short articles called posts, typically a chronologically ordered series of website updates written and organized like a traditional diary.{{sfn|Bair|2014|p=7}} They are regularly updated, providing readers with insights on a specific topic or subject. Blogs serve various purposes, including sharing opinions, providing news, offering educational content, and documenting personal experiences.{{sfn|Rose|Garret|2012|p=2}} | ||
====Forums==== | ====Forums==== | ||
| Line 200: | Line 205: | ||
==='''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}} 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 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 user experience (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's preference. Different personas can influence and guide the design of the project. | ||
Along with adjusting tone and language to | Along with adjusting tone and language to suit the desired user, personas can be used to ensure the purposed digital document properly informs the reader with the correct and accurate information the user seeks. | ||
=== '''Rhetoric'''=== | === '''Rhetoric'''=== | ||
| Line 214: | Line 219: | ||
==='''Tools for Digital Technology'''=== | ==='''Tools for Digital Technology'''=== | ||
With the rise of digital technology, technical writing has had to adapt to the needs of a digital era. | With the rise of digital technology, technical writing has had to adapt to the needs of a digital era. Technical writers can use various tools to author and present their documents. | ||
Technical writers can use various tools to author and present their documents. | |||
====Content Management Systems (CMS)==== | ====Content Management Systems (CMS)==== | ||
| Line 226: | Line 229: | ||
====Word Processors==== | ====Word Processors==== | ||
[[File:Word processor logos.jpg|thumb|The logos of popular word processors: (L-R Clockwise) Apple Pages, Google Docs, SharePoint, Microsoft Word. ]] | [[File:Word processor logos.jpg|thumb|The logos of popular word processors: (L-R Clockwise) Apple Pages, Google Docs, SharePoint, Microsoft Word. ]] | ||
Word processors are software applications designed for creating, editing, and formatting documents on a computer. They provide many features, such as spell-checking, grammar | Word processors are software applications designed for creating, editing, and formatting documents on a computer. They provide many features, such as spell-checking, checking grammar, and inserting images and tables. These programs are typically used for writing essays, creating reports, or drafting professional documents.{{sfn|Carroll|2010|p=229}} Some popular software applications are [https://www.microsoft.com/en-us/microsoft-365/word Microsoft Word], [https://www.google.com/docs/about/ Google Docs][https://www.microsoft.com/en-us/microsoft-365/sharepoint/collaboration , SharePoint], and [https://www.apple.com/pages/ Apple Pages]. These programs allow documents to be readily disseminated. Comment capability enables audience members to interact about a document with one another and the author. | ||
====Text Editors==== | ====Text Editors==== | ||
| Line 232: | Line 235: | ||
==='''Search Engine Optimization (SEO)'''=== | ==='''Search Engine Optimization (SEO)'''=== | ||
SEO refers to the practice of optimizing online content to enhance its visibility and ranking on search engine results pages (SERPs), making it a crucial skill for digital writers.{{sfn|Lucas|2023b}} To optimize content for SEO means to have the goal of SEO in mind at the time of designing, creating, and writing a web page for publication. Using keywords and alt | SEO refers to the practice of optimizing online content to enhance its visibility and ranking on search engine results pages (SERPs), making it a crucial skill for digital writers.{{sfn|Lucas|2023b}} To optimize content for SEO means to have the goal of SEO in mind at the time of designing, creating, and writing a web page for publication. Using keywords and alt text are two examples of optimizing content for SEO.{{sfn|Barr|2010|loc=chpt. 17}} | ||
====Keywords==== | ====Keywords==== | ||
Keywords are the words that search engines scan a website for and index as the page's most important words. Based on other pages using the same keywords, the website is added | Keywords are the words that search engines scan a website for and index as the page's most important words. Based on other pages using the same keywords, the website is added to the search engine results pages from best matches to worst matches. The position of a website in search results is influenced by where it ranks on a scale determined by the keywords that a user searches for.{{sfn|Lucas|2023b}} To optimize a website's keywords, you should begin with researching keywords on your own website and ensure that you have an XML [https://en.wikipedia.org/wiki/Sitemaps sitemap] so search engines such as [https://en.wikipedia.org/wiki/Google Google] can scan 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 | ====Alt Text==== | ||
Alt | Alt text (alternative text), or [https://en.wikipedia.org/wiki/Alt_attribute alt attributes], is a practice that increases the usability and accessibility of a web page for users. Alt text is often used for visual elements that cannot be displayed in a different format but still provides description of the element for screen readers or users that may have a disability. Alt text also improves a website's SEO as a form of content optimization.{{sfn|Lucas|2023b}} | ||
====Social Media Presence==== | ====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 | [[File:Facebook logo.png|thumb|212x212px|Facebook Logo]] | ||
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 the visibility of the website overall. Additionally, it can drive traffic and enable backlinking, where other websites can link to the website.{{sfn|Lucas|2023b}} | |||
====Goals of Searching: The User's Perspective==== | ====Goals of Searching: The User's Perspective==== | ||
| Line 252: | Line 256: | ||
User-centered design (UCD) is implemented by considering the user and their needs throughout the entire development of a product.{{sfn|Garrett|2011|p=17}} The approach of UCD in technical writing consists of the following methodologies:{{sfn|Lucas|2023e}} | User-centered design (UCD) is implemented by considering the user and their needs throughout the entire development of a product.{{sfn|Garrett|2011|p=17}} The approach of UCD in technical writing consists of the following methodologies:{{sfn|Lucas|2023e}} | ||
*User Research: 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 | *'''User Research''': 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: the process of creating digital designs and prototypes to assist with exploring possible solutions to meet user needs | *'''Ideation and prototyping''': the process of creating digital designs and prototypes to assist with exploring possible solutions to meet user needs | ||
*Usability testing: the act of having users interact with digital document designs and then adjusting the design based on user feedback | *'''Usability testing''': the act of having users interact with digital document designs and then adjusting the design based on user feedback | ||
*Implementation: the stage in which the design is implemented after | *'''Implementation''': the stage in which the design is implemented after adjusting from prior testing | ||
*Evaluation: the stage in which the digital document is assessed to ensure that it is meeting user needs | *'''Evaluation''': the stage in which the digital document is assessed to ensure that it is meeting user needs | ||
*Maintenance and updates: to maintain a digital document based on user feedback and changing needs | *'''Maintenance and updates''': to maintain a digital document based on user feedback and changing needs | ||
====Information Architecture==== | ====Information Architecture==== | ||
| Line 265: | Line 269: | ||
The architecture components of IA can be divided into four different categories:{{sfn|Rosenfeld|Morville|Arango|2006|p=90}} | The architecture components of IA can be divided into four different categories:{{sfn|Rosenfeld|Morville|Arango|2006|p=90}} | ||
*Organization systems: how information is categorized and organized for user understanding | *'''Organization systems''': how information is categorized and organized for user understanding | ||
*Labeling systems: how information is represented | *'''Labeling systems''': how information is represented | ||
*Navigation systems: how users browse information and navigate between pages | *'''Navigation systems''': how users browse information and navigate between pages | ||
* Searching systems: how users search for specific information | * '''Searching systems''': how users search for specific information | ||
====Responsive Design==== | ====Responsive Design==== | ||
| Line 279: | Line 283: | ||
There are several design strategies that can be implemented that will increase the success of RWD:{{sfn|Robbins|2018|p=487}} | There are several design strategies that can be implemented that will increase the success of RWD:{{sfn|Robbins|2018|p=487}} | ||
*Fluid layout: Responsive sites can be constructed using a fluid layout (or flexible grid) system that will allow content to adjust and flow according to the available screen space. | *'''Fluid layout''': Responsive sites can be constructed using a fluid layout (or flexible grid) system that will allow content to adjust and flow according to the available screen space. | ||
* | *F'''lexible and responsive images''': Images and other embedded media can be instructed to fit their containers instead of remaining at a fixed size. Images with varying resolutions can also be swapped according to screen size to avoid high-resolution images on smaller devices. | ||
*CSS media queries: Media queries can be written into the CSS (Cascading Style Sheet), instructing the site's construction according to screen width and orientation. Adding breakpoints for several screen sizes allows pages to be designed for specific devices. | *'''CSS media queries''': Media queries can be written into the CSS (Cascading Style Sheet), instructing the site's construction according to screen width and orientation. Adding breakpoints for several screen sizes allows pages to be designed for specific devices. | ||
*Content hierarchy: Carefully constructing content that is organized for the user and creating a hierarchy of content that prioritizes user needs is necessary to ensure effective user experience and navigation across multiple screen sizes.{{sfn|Robbins|2018|p=499}} | *'''Content hierarchy''': Carefully constructing content that is organized for the user and creating a hierarchy of content that prioritizes user needs is necessary to ensure effective user experience and navigation across multiple screen sizes.{{sfn|Robbins|2018|p=499}} | ||
====Multimodality==== | ====Multimodality==== | ||
While responsive design focuses on the system or interface response to user inputs, multimodality refers to integrating multiple modes of communication to evaluate how effective communication can be in the digital age. {{sfn|Lucas|2023h|p=}} | While responsive design focuses on the system or interface response to user inputs, multimodality refers to integrating multiple modes of communication to evaluate how effective communication can be in the digital age.{{sfn|Lucas|2023h|p=}} | ||
There are essential elements to multimodality that improve the UX experience for readers in digital documents: | There are essential elements to multimodality that improve the UX experience for readers in digital documents: | ||
*'''Accessibility''': Documents that contain multimodal, or multimedia elements, allow for diversity in obtaining information to cater to diverse learning styles and abilities. For example, a slideshow presentation that contains audio will help aid those with visual impairments. | *'''Accessibility''': Documents that contain multimodal, or multimedia elements, allow for diversity in obtaining information to cater to diverse learning styles and abilities. For example, a slideshow presentation that contains audio will help aid those with visual impairments. | ||
*'''Engagement''': Combining static information with visuals such as images, videos, or interactive modules, can create a more engaging experience for readers in the digital age. | *'''Engagement''': Combining static information with visuals, such as images, videos, or interactive modules, can create a more engaging experience for readers in the digital age. | ||
*'''Clarity and Comprehension''': Jargon heavy text and complex ideas are able to be showcased in charts, diagrams, and infographics that are easily able to clarify concepts better than text. | *'''Clarity and Comprehension''': Jargon-heavy text and complex ideas are able to be showcased in charts, diagrams, and infographics that are easily able to clarify concepts better than text. | ||
*'''Persuasion''': Combining the elements listed above may allow for the creators to influence their audience. | *'''Persuasion''': Combining the elements listed above may allow for the creators to influence their audience. | ||
| Line 318: | Line 322: | ||
====Remediation==== | ====Remediation==== | ||
Remediation is the process through which new media forms borrow elements from older media forms and transform and re-contextualize them. As media evolves, so do the ways users can consume it. When first introduced, remediation was described as a type of reformation such as taking a paper letter and turning it into an email.{{sfn|Bolter|Grusin|1999|p=59}}Today, remediation of a digital document often adds | Remediation is the process through which new media forms borrow elements from older media forms and transform and re-contextualize them. As media evolves, so do the ways users can consume it. When first introduced, remediation was described as a type of reformation, such as taking a paper letter and turning it into an email.{{sfn|Bolter|Grusin|1999|p=59}} Today, remediation of a digital document often adds to the user experience by enhancing the document. An example of remediation is making a document more accessible by adding a text-to-speech feature for users with poor vision or adding a tutorial to an electronic manual. | ||
This can be simplified into two key principals: | This can be simplified into two key principals: | ||
* '''Immediacy and Hypermediacy:''' Immediacy refers to the desire to transcend a medium, while hypermediacy takes the medium and infuses it through the new medium.{{sfn|Bolter|Grusin|1999|p=53}} | * '''Immediacy and Hypermediacy:''' Immediacy refers to the desire to transcend a medium, while hypermediacy takes the medium and infuses it through the new medium.{{sfn|Bolter|Grusin|1999|p=53}}{{sfn|Lucas|2023k}} | ||
* '''Transparent and Opaque Media:''' Transparent media allows the content to take center stage, while opaque media makes users aware of the medium's presence.{{sfn|Bolter|Grusin|1999|p=53}} | * '''Transparent and Opaque Media:''' Transparent media allows the content to take center stage, while opaque media makes users aware of the medium's presence.{{sfn|Bolter|Grusin|1999|p=53}}{{sfn|Lucas|2023k}} | ||
Overall, remediation is necessary to create a multimodal document in the digital age. | Overall, remediation is necessary to create a multimodal document in the digital age. | ||
| Line 329: | Line 333: | ||
=='''Pedagogical Approaches'''== | =='''Pedagogical Approaches'''== | ||
==='''Writing Styles'''=== | ==='''Writing Styles'''=== | ||
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 in their schoolwork. Others even used emoticons. Colleges and universities must now educate students on the different forms of written communication | 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 in their schoolwork. Others even used emoticons. Colleges and universities must now educate students on the different forms of written communication and when best to employ them.{{sfn|Carroll|2010|p=20}} | ||
==='''Multimedia Writing'''=== | ==='''Multimedia Writing'''=== | ||
Best practices for tone, grammar, and style can vary depending on the form of media (auditory, visual, print, etc.), and many digital writings will combine two or more of these media formats. Students of technical writing may be taught specific techniques for different types of media | Best practices for tone, grammar, and style can vary depending on the form of media (auditory, visual, print, etc.), and many digital writings will combine two or more of these media formats. Students of technical writing may be taught specific techniques for different types of media to become proficient multimedia writers.{{sfn|Garrand|2006|p=23}} In their book ''Reading Images: The Grammar of Visual Design'', Gunther Kress and Theo van Leeuwen introduce the concept of visual grammar, which relates to multimodality that helps with complex ideas in visual grammar. Kress and van Leeuwen suggest that visual elements should follow a set of grammatical rules to construct visual designs.{{sfn|Kress|van Leeuwen|2020}} | ||
==='''Breaking and Building''' === | ==='''Breaking and Building''' === | ||
Breaking and building is a method of teaching effective writing that can be applied to technical and digital formats. It asks students to curate collections of digital media by comparing and contrasting ("building") | Breaking and building is a method of teaching effective writing that can be applied to technical and digital formats. It asks students to curate collections of digital media by comparing and contrasting ("building") and to critically analyze these collections and attempt to reason out the decisions behind them ("breaking").{{sfn|Coco|Torres|2014|p=175}} Each process has a set of targeted learning outcomes. Learning outcomes for "building" include making and reflecting on choices to find, group, present, and compile digital content. Learning outcomes for "breaking" include identifying and critiquing decisions in curating existing digital content, such as where the content originated, how it is grouped, and how it is presented.{{sfn|Coco|Torres|2014|pp=178-179}} | ||
=='''Challenges and Ethical Considerations'''== | =='''Challenges and Ethical Considerations'''== | ||
| Line 344: | Line 348: | ||
==='''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.{{sfn|Marr|2023}} | Artificial intelligence programs, utilizing natural language processing, are capable of producing technical writing and have advanced in recent years becoming more adept.{{sfn|Marr|2023}} | ||
[[File:Chatgpt logo.jpg|thumb|297x297px|Logo for ChatGPT - an open AI that has rose in popularity.]] | |||
One such program is [https://en.wikipedia.org/wiki/ChatGPT ChatGPT], which uses machine learning to produce texts with human-like style and tone.{{sfn|University of Central Arkansas|2023}} Another leader in this area, Contentbot, uses a WordPress plugin which gives blog writers ideas to enhance their posts which are shared via email.{{sfn|Siddiqui|2022}} | One such program is [https://en.wikipedia.org/wiki/ChatGPT ChatGPT], which uses machine learning to produce texts with human-like style and tone.{{sfn|University of Central Arkansas|2023}} Another leader in this area, Contentbot, uses a WordPress plugin which gives blog writers ideas to enhance their posts which are shared via email.{{sfn|Siddiqui|2022}} | ||
| Line 354: | Line 358: | ||
==='''Ethical Considerations''' === | ==='''Ethical Considerations''' === | ||
Technical communicators: | |||
* Observes laws, regulations, and fulfil contracts. | |||
* Further the public good. | |||
* Respect the confidentiality of clients. | |||
* Produce quality products. | |||
* Embrace fairness with respect to cultural diversity. | |||
* Pursue professional self-improvement and education. <ref>[https://www.stc.org/about-stc/ethical-principles/]</ref> | |||
The concept of ethics involves decision making based on value systems. Value systems are based on societal norms of acceptable behavior. Ethical dilemmas are decision opportunities in which value systems do not provide clear instruction for the appropriate course of action.{{sfn|Johnson-Sheehan|2018|pp=71}} | The concept of ethics involves decision making based on value systems. Value systems are based on societal norms of acceptable behavior. Ethical dilemmas are decision opportunities in which value systems do not provide clear instruction for the appropriate course of action.{{sfn|Johnson-Sheehan|2018|pp=71}} | ||
| Line 426: | Line 439: | ||
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Accessibility |title=The Imperative of Accessibility in Digital Writing |last=Lucas |first=Gerald |author-mask=1 |date=2023i |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-29 }} | * {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Accessibility |title=The Imperative of Accessibility in Digital Writing |last=Lucas |first=Gerald |author-mask=1 |date=2023i |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-29 }} | ||
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Scannability |title=Scannability |last=Lucas |first=Gerald |author-mask=1 |date=2023j |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-29 }} | * {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Scannability |title=Scannability |last=Lucas |first=Gerald |author-mask=1 |date=2023j |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-29 }} | ||
{{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Remediation|title=Remediation in Technical Writing: Bridging the Analog-Digital Divide |last=Lucas |first=Gerald |author-mask=1 |date= | *{{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Remediation|title=Remediation in Technical Writing: Bridging the Analog-Digital Divide |last=Lucas |first=Gerald |author-mask=1 |date=2023k |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-30 }} | ||
* {{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 }} | * {{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 }} | ||
* {{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=2023-10-31 }} | * {{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=2023-10-31 }} | ||