Jump to content

Technical Writing in the Digital Age: Difference between revisions

m
Restored a couple of minor changes that got lost in my previous edit
m (→‎Disinformation: Reviewed for clarity, neutral tone and grammar)
m (Restored a couple of minor changes that got lost in my previous edit)
Line 265: Line 265:
==== '''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 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}}   


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}}   
Line 271: Line 271:
*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.


*Flexible and responsive images: Images and other embedded media can be instructed so that they 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.  
*Flexible 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), which would instruct the construction of the site 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 the integration of multiple modes of channels of communication to evaluate how effective communication can be in the digital age.<ref>Lucas, Gerald (2023). [[grl:CompFAQ/Digital_Writing/Multimodal_Approach|"Multimodal Approaches in Technical Writing"]]. grlucas.net. MediaWiki. Retrieved 2023-11-29. </ref>
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.<ref>Lucas, Gerald (2023). [[grl:CompFAQ/Digital_Writing/Multimodal_Approach|"Multimodal Approaches in Technical Writing"]]. grlucas.net. MediaWiki. Retrieved 2023-11-29. </ref>


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


Technical writers must create documents and websites that meet the expectations of their readers and users, and 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 will have 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}}  


A document or website written for usability can be easily scanned by using the following concepts:{{sfn|Garrand|2006|pp=25-26}}  
A document or website written for usability can be easily scanned by using the following concepts:{{sfn|Garrand|2006|pp=25-26}}  
32

edits