339
edits
Technical Writing in the Digital Age: Difference between revisions
Technical Writing in the Digital Age (view source)
Revision as of 17:24, 17 November 2023
, 1 year agoUndo revision 19291 by Natecole54 (talk) - This is unnecessary.
(Removed citations in lead section. It not contain citations. Save those for the body. (Also, the lead § should be revised.) See MOS:CITELEAD on Wikipedia.) |
(Undo revision 19291 by Natecole54 (talk) - This is unnecessary.) Tag: Undo |
||
| Line 120: | Line 120: | ||
===Characteristics of Digital Documents=== | ===Characteristics of Digital Documents=== | ||
==== | ====Accessibility ==== | ||
Website content should be designed in accordance with Web Content Accessibility Guidelines (WCAG) to ensure that individuals with disabilities are able to access the same information as those without disabilities.{{sfn|WAI |2022| }} It is a legal requirement to include accessibility features in website design.{{sfn|WAI || }} There are four different types of impairment that can affect how a user interacts and perceives digital documents: vision, mobility, auditory, and cognitive.{{sfn|Robbins|2018|p=42}}Digital documents will need to be optimized so that information can be accessed by hardware and software tools used by people with disabilities.{{sfn|Barr|2010|p=103-104}} | Website content should be designed in accordance with Web Content Accessibility Guidelines (WCAG) to ensure that individuals with disabilities are able to access the same information as those without disabilities.{{sfn|WAI |2022| }} It is a legal requirement to include accessibility features in website design.{{sfn|WAI || }} There are four different types of impairment that can affect how a user interacts and perceives digital documents: vision, mobility, auditory, and cognitive.{{sfn|Robbins|2018|p=42}}Digital documents will need to be optimized so that information can be accessed by hardware and software tools used by people with disabilities.{{sfn|Barr|2010|p=103-104}} | ||
==== | ====Readability==== | ||
Digital documents rely on the "Seven Cs" of precise writing to be effective and increase readability. Forms of technical writing must have readability. Readability is a term used to determine whether the content has clarity, conciseness and courtesy.{{sfn|Zeleznik, Burnett, & Benson|1999|p=207}} The other four Cs are coherent, concrete, correct and complete.<ref>Last, Suzan (2019). ''Technical Writing Essentials.'' Victoria, B.C. University of Victoria. ISBN: 9781550586657 https://pressbooks.bccampus.ca/technicalwriting/chapter/communicatingprecision/</ref> | 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.<ref>Last, Suzan (2019). ''Technical Writing Essentials.'' Victoria, B.C. University of Victoria. ISBN: 9781550586657 https://pressbooks.bccampus.ca/technicalwriting/chapter/communicatingprecision/</ref> | ||
==== | ====Scannability==== | ||
A document's scannability is determined by the ease in which it can be scanned to determine meaning. Readers often scan pages for words and phrases that align with their task or interests, as well as for trigger words that are deeply ingrained.{{sfn|Krug|2014|p=23}}The most effective web content is concise and simple to scan, making it easy for users to find the important information. Breaking up text into interesting, easy-to-read sections helps users quickly find information. {{sfn|Barr|2010|p=103}} | A document's scannability is determined by the ease in which it can be scanned to determine meaning. Readers often scan pages for words and phrases that align with their task or interests, as well as for trigger words that are deeply ingrained.{{sfn|Krug|2014|p=23}}The most effective web content is concise and simple to scan, making it easy for users to find the important information. Breaking up text into interesting, easy-to-read sections helps users quickly find information. {{sfn|Barr|2010|p=103}} | ||
==== | ====Hyperlinking==== | ||
Hyperlinking is a quick and efficient method for directing readers to relevant information in digital documents, facilitating seamless navigation between sections, references, and external resources.{{sfn|Carroll|2010|p=79}} | Hyperlinking is a quick and efficient method for directing readers to relevant information in digital documents, facilitating seamless navigation between sections, references, and external resources.{{sfn|Carroll|2010|p=79}} | ||
==== | ====Multimedia==== | ||
Digital documents can incorporate multimedia elements like images, audio, video, and interactive content, enhancing engagement through visual and auditory elements. Multiple media formats work best when sharing new, complicated ideas.{{sfn|Carroll|2010|p=36}} Increasing multimodality on a website improves engagement, usability, and accessibility. This can improve the impact of the website's standings in SERPs.<ref name=":5" /> | Digital documents can incorporate multimedia elements like images, audio, video, and interactive content, enhancing engagement through visual and auditory elements. Multiple media formats work best when sharing new, complicated ideas.{{sfn|Carroll|2010|p=36}} Increasing multimodality on a website improves engagement, usability, and accessibility. This can improve the impact of the website's standings in SERPs.<ref name=":5" /> | ||
==== | ====Version Control==== | ||
Version control is a characteristic of digital documents that allows for the tracking of edits and revisions to digital documents. In collaborative writing, version control helps maintain the document with accountability and transparency.{{sfn|Lucas|2023|p=}} | 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.{{sfn|Lucas|2023|p=}} | ||
==== | ==== Remote Collaboration ==== | ||
One form of collaborative technical writing is a wiki, which is a "Web site developed collaboratively by a community of users, allowing any user to add and edit content."<ref>{{cite web | One form of collaborative technical writing is a wiki, which is a "Web site developed collaboratively by a community of users, allowing any user to add and edit content."<ref>{{cite web | ||
| url = https://grlucas.net/grl/Writing_on_a_Wiki | | url = https://grlucas.net/grl/Writing_on_a_Wiki | ||
| Line 182: | Line 182: | ||
The approach of user-centered design in technical writing consists of the following methodology<ref>Lucas, Gerald. (September 21,2023). [[grl:CompFAQ/Digital_Writing/Design/Users|"User Centered Design and Digital Documents."]] grlucas.net. MediaWiki. Retrieved November 15, 2023.</ref>: | The approach of user-centered design in technical writing consists of the following methodology<ref>Lucas, Gerald. (September 21,2023). [[grl:CompFAQ/Digital_Writing/Design/Users|"User Centered Design and Digital Documents."]] grlucas.net. MediaWiki. Retrieved November 15, 2023.</ref>: | ||
==== | ==== 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. | 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. | 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. | 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. | 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. | 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. | Maintenance and updates are required in order to maintain a digital document based on user feedback and changing needs. | ||