Technical Writing in the Digital Age: Difference between revisions

(→‎Case Studies: Added definition)
(Added definition and citation.)
Line 20: Line 20:


==== Data Sheets ====
==== Data Sheets ====
 
A data sheet, also known as a technical datasheet, is a document used to describe and summarize the characteristics of a product, material, component, or technology. {{sfn|IDA|2020|p=}}
==== 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}}
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}}
Line 268: Line 268:
* {{cite book |last=Garrett |first=Jesse James |title=The Elements of User Experience: User-Centered Design for the Web and Beyond |publisher=New Riders |edition=2nd |date=2011 |location=Berkeley, CA |page=17 }}  
* {{cite book |last=Garrett |first=Jesse James |title=The Elements of User Experience: User-Centered Design for the Web and Beyond |publisher=New Riders |edition=2nd |date=2011 |location=Berkeley, CA |page=17 }}  
* {{cite web |url=https://smashingmagazine.com/2014/08/a-closer-look-at-personas-part-2/ |title=A Closer Look at Personas: A Guide to Developing The Right Ones (Part 2) |last=Goltz | first=Shlomo |date=2014 |website=smashingmagazine.com |publisher=Smashing Media AG |access-date=2023-11-13 }}
* {{cite web |url=https://smashingmagazine.com/2014/08/a-closer-look-at-personas-part-2/ |title=A Closer Look at Personas: A Guide to Developing The Right Ones (Part 2) |last=Goltz | first=Shlomo |date=2014 |website=smashingmagazine.com |publisher=Smashing Media AG |access-date=2023-11-13 }}
* {{cite magazine |last=Grimstead |first=Deborah M. |date=1999 |title=Technical Writers are in Demand: Do You Have The Right Stuff? |magazine=Black Collegian |pages=128 }}   
* {{cite magazine |last=Grimstead |first=Deborah M. |date=1999 |title=Technical Writers are in Demand: Do You Have The Right Stuff? |magazine=Black Collegian |pages=128 }}
* {{cite web |url=https://www.idassoc.com/product-information-definition/data-sheet |title=Product Information Encyclopedia |last=IDA |first= |date=2020 |website=Industrial Data Associates |publisher= |access-date=2023-11-20 |quote= |ref=harv }}   
* {{cite book |last=Johnson-Sheehan |first=Richard |title=Technical Communication Today |url= |edition=6 |chapter=Chapter 4: Managing Ethical Challenges |location=Boston, MA |publisher=Pearson |date=2018 |pages=71-98 }}
* {{cite book |last=Johnson-Sheehan |first=Richard |title=Technical Communication Today |url= |edition=6 |chapter=Chapter 4: Managing Ethical Challenges |location=Boston, MA |publisher=Pearson |date=2018 |pages=71-98 }}
* {{cite news |last=Klein |first=Alyson |date=2023 |title=ChatGPT Cheating: What to Do When It Happens |url=https://www.edweek.org/technology/chatgpt-cheating-what-to-do-when-it-happens/ |work=Education Week |location=Bethesda, MD |access-date=2023-11-05 }}
* {{cite news |last=Klein |first=Alyson |date=2023 |title=ChatGPT Cheating: What to Do When It Happens |url=https://www.edweek.org/technology/chatgpt-cheating-what-to-do-when-it-happens/ |work=Education Week |location=Bethesda, MD |access-date=2023-11-05 }}