Technical Writing in the Digital Age: Difference between revisions

m
→‎User Experience: removed bold formatting as to be consistent with other subheadings
m (→‎Search Engine Optimization (SEO): removed bold formatting as to be consistent with other subheadings)
m (→‎User Experience: removed bold formatting as to be consistent with other subheadings)
Line 248: Line 248:
User experience (UX) is how a product works and is experienced from the user's perspective.{{sfn|Garrett|2011|p=6}} By creating a positive user experience, technical writers can ensure the intended message is effectively communicated and retained. UX design methods include user-centered design, information architecture, responsive design, multimodality, and usability.  
User experience (UX) is how a product works and is experienced from the user's perspective.{{sfn|Garrett|2011|p=6}} By creating a positive user experience, technical writers can ensure the intended message is effectively communicated and retained. UX design methods include user-centered design, information architecture, responsive design, multimodality, and usability.  


===='''User-Centered Design'''====
====User-Centered Design====
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}}


Line 258: Line 258:
*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====


To ensure a digital document has effective UX design and accessible information, technical writers must construct a clear and organized information architecture (IA). IA is a design principle that organizes information so that it is easily found and understood by users, prioritizing their needs and reducing information overload. A design challenge is making IA understood across multiple digital experiences, changing the navigation structure to fit different media while staying logical and consistent for the user.{{sfn|Rosenfeld|Morville|Arango|2006|pp=1, 17-18}} IA that is not constructed well can confuse the user and could cause them to give up their search of information in frustration.{{sfn|Garrand|2006|p=12}}   
To ensure a digital document has effective UX design and accessible information, technical writers must construct a clear and organized information architecture (IA). IA is a design principle that organizes information so that it is easily found and understood by users, prioritizing their needs and reducing information overload. A design challenge is making IA understood across multiple digital experiences, changing the navigation structure to fit different media while staying logical and consistent for the user.{{sfn|Rosenfeld|Morville|Arango|2006|pp=1, 17-18}} IA that is not constructed well can confuse the user and could cause them to give up their search of information in frustration.{{sfn|Garrand|2006|p=12}}   
Line 272: Line 272:
* Searching systems: how users search for specific information
* Searching systems: how users search for specific information


===='''Responsive Design'''====
====Responsive Design====


Responsive design is a strategy that appropriately updates the layout and content of a website or document in relation to the screen size, device, and/or orientation, allowing the site or document to be easily viewed and navigated regardless of the device used. With the increased use of mobile devices, web content should be constructed with proper responsive web design (RWD) to ensure effective UX and usability on those devices.{{sfn|Robbins|2018|p=485}}   
Responsive design is a strategy that appropriately updates the layout and content of a website or document in relation to the screen size, device, and/or orientation, allowing the site or document to be easily viewed and navigated regardless of the device used. With the increased use of mobile devices, web content should be constructed with proper responsive web design (RWD) to ensure effective UX and usability on those devices.{{sfn|Robbins|2018|p=485}}   
Line 286: Line 286:
*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=}}


Line 296: Line 296:
*'''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.


===='''Usability'''====
====Usability====


Technical writers must create documents and websites that meet the expectations of their readers and users. In doing so, writers increase the usability of their site or document.{{sfn|Garrand|2006|p=26}} Usability consultant Steve Krug considers the most important rule for ensuring a site or document is usable is by making pages self-evident and allowing the user not to have to think about actions.{{sfn|Krug|2014|pp=11-18 }} A website that is well designed for usability means that the users will not have any questions about the content or functions of the site. The site will have a clear hierarchy, use standard web design principles, have well-defined content areas, include noticeable and simple links, and limited distractions.{{sfn|Carroll|2010|p=69}}  
Technical writers must create documents and websites that meet the expectations of their readers and users. In doing so, writers increase the usability of their site or document.{{sfn|Garrand|2006|p=26}} Usability consultant Steve Krug considers the most important rule for ensuring a site or document is usable is by making pages self-evident and allowing the user not to have to think about actions.{{sfn|Krug|2014|pp=11-18 }} A website that is well designed for usability means that the users will not have any questions about the content or functions of the site. The site will have a clear hierarchy, use standard web design principles, have well-defined content areas, include noticeable and simple links, and limited distractions.{{sfn|Carroll|2010|p=69}}  
Line 316: Line 316:
*Using clear and concise language and, when appropriate, visual aids
*Using clear and concise language and, when appropriate, visual aids


==== '''Remediation''' ====
====Remediation====
Remediation is the process through which new media forms borrow elements from older media forms and transforms and re-contextualizes 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 into user-experience by enhancing the document. Remediation can look like 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.
Remediation is the process through which new media forms borrow elements from older media forms and transforms and re-contextualizes 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 into user-experience by enhancing the document. Remediation can look like 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.


32

edits