CompFAQ/WritDM: Difference between revisions

From Gerald R. Lucas
(Lesson 1 finished. Added bib.)
(Additions.)
Line 10: Line 10:
#* [[CompFAQ/Digital Writing|What is “digital writing”?]]
#* [[CompFAQ/Digital Writing|What is “digital writing”?]]
#* [[CompFAQ/Digital Writing/Tech Writing|What is “technical writing in the digital age”?]]
#* [[CompFAQ/Digital Writing/Tech Writing|What is “technical writing in the digital age”?]]
#* [[CompFAQ/Digital Writing/Skills|Digital literacy requires what skills?]]
#* [[CompFAQ/Digital Writing/Skills/Development|What practical development skills should digital writers have?]]
#* [[CompFAQ/Digital Writing/Skills/Development|What practical development skills should digital writers have?]]
#* [[CompFAQ/Digital Writing/Professional Domain|Why do I need a professional domain name?]]
#* [[CompFAQ/Digital Writing/Professional Domain|Why do I need a professional domain name?]]
Line 19: Line 18:
#* “Introduction to Technical Communication” — chapter 1 of {{harvtxt|Lannon|Gurak|2022}}
#* “Introduction to Technical Communication” — chapter 1 of {{harvtxt|Lannon|Gurak|2022}}
#* “Introducing Design Thinking (and Making) for Technical Communication” — chapter 1 of {{harvtxt|Tham|2021}}
#* “Introducing Design Thinking (and Making) for Technical Communication” — chapter 1 of {{harvtxt|Tham|2021}}
#* “The Landscape of Digital Writing” — chapter 1 in {{harvtxt|DeVoss|Eidman-Aadahl|Hicks|2010}}
# To Do: [[ENGL 5106/Establishing Your Professional Persona|Establishing Your Professional Persona]]
# To Do: [[ENGL 5106/Establishing Your Professional Persona|Establishing Your Professional Persona]]
# Post: Introduce yourself and the professional, or discourse, community that you will represent in your writing this semester and/or perhaps in the future as a professional. What is your understanding of “technical writing in the digital age” at this point? What did you glean from your reading? Which seem most applicable to your interests as a digital writer? The project above asks you to announce your new domain name; you may do that in this post. (750–1000 words)
# Post: Introduce yourself and the professional, or discourse, community that you will represent in your writing this semester and/or perhaps in the future as a professional. What is your understanding of “technical writing in the digital age” at this point? What did you glean from your reading? Which seem most applicable to your interests as a digital writer? The project above asks you to announce your new domain name; you may do that in this post. (750–1000 words)


==2: Digital Literacy and Skills==
==2: Strong Writing, Digital Literacy, and Credibility==
# Digital Literacy: What It Entails
# String Writing & Digital Literacy: What They Entail
#* Essential Digital Writing Skills
#* [[CompFAQ/Digital Writing/Skills|Digital literacy requires what skills?]]
#* [[CompFAQ/Digital Writing/Personas|What are personas?]]
#* [[CompFAQ/Digital Writing/Credibility|How do I build and maintain “credibility”?]]
# Additional Reading (choose at least one)
#* “25 Ways to Improve Writing Immediately” — chapter 1 of {{harvtxt|Arnold|2013}}
#* “On Writing Well” — chapter 1 of {{harvtxt|Carroll|2010}}
#* “Shorten and Strengthen Sentences” — chapter 13 of {{harvtxt|Barr|2010}}
#* “Ethics” — chapter 5 of {{harvtxt|Balzotti|2022}}
# Post: Evaluating Digital Literacy in Technical Writing
# Post: Evaluating Digital Literacy in Technical Writing
# Reading: "Writing and Community Engagement: A Critical Sourcebook" edited by Thomas Deans and "Digital Literacy for Technical Communication" by Rachel Spilka
# Reading: "Writing and Community Engagement: A Critical Sourcebook" edited by Thomas Deans and "Digital Literacy for Technical Communication" by Rachel Spilka
Line 30: Line 37:
==3: Style and Tone in Digital Writing==
==3: Style and Tone in Digital Writing==
# Style Guidelines for Digital Writing
# Style Guidelines for Digital Writing
#* The Impact of Tone in Online Communication
#* [[CompFAQ/Digital Writing/Style|Should digital writing use a particular style?]]
# Additional Reading (choose one)
#* “Digital Media Versus Analog Media” — chapter 2 of {{harvtxt|Carroll|2010}}
#* “Write for the Web” — chapter 1; “Define Your Voice” — chapter 3 of {{harvtxt|Barr|2010}}
#* “Style” — chapter 3 of {{harvtxt|Balzotti|2022}}
#* “Revising the Writing Process: Learning to Write in a Digital World” — chapter 2 in {{harvtxt|DeVoss|Eidman-Aadahl|Hicks|2010}}
# Post: Crafting Effective Digital Messages
# Post: Crafting Effective Digital Messages
# Reading: "Style: Lessons in Clarity and Grace" by Joseph M. Williams and "The Elements of Style" by William Strunk Jr. and E.B. White
# Reading: "Style: Lessons in Clarity and Grace" by Joseph M. Williams and "The Elements of Style" by William Strunk Jr. and E.B. White
Line 36: Line 48:
==4: Digital Documents and Remediation==
==4: Digital Documents and Remediation==
# Digital vs. Paper Documents: Key Differences
# Digital vs. Paper Documents: Key Differences
#* Understanding Remediation in Digital Contexts
#* [[CompFAQ/Digital Writing/Documents|How do digital “documents” differ from paper ones?]]
#* [[CompFAQ/Digital Writing/Remediation|What is “remediation”?]]
#* [[CompFAQ/Digital Writing/Design|What is “document design”?]]
#* [[CompFAQ/Digital Writing/Multimodal Approach|What is a “multimodal approach”?]]
# Additional Reading (choose one)
#* “Screen Writing: Online Style and Techniques” — chapter 3 of {{harvtxt|Carroll|2010}}
#* “Headlines and Hypertext” — chapter 4 of {{harvtxt|Carroll|2010}}
#* “Write Clear User-Interface Text” — chapter 7 of {{harvtxt|Barr|2010}}
#* “Design-Centric Communication” — chapter 2 of {{harvtxt|Balzotti|2022}}
# Post: Analyzing Digital Document Transformations
# Post: Analyzing Digital Document Transformations
# Reading: "Remediation: Understanding New Media" by Jay David Bolter and Richard Grusin and "Writing for the Web" by Lynda Felder
# Reading: "Remediation: Understanding New Media" by Jay David Bolter and Richard Grusin and "Writing for the Web" by Lynda Felder
Line 42: Line 62:
==5: User-Centered Design and Information Architecture==
==5: User-Centered Design and Information Architecture==
# Principles of User-Centered Design
# Principles of User-Centered Design
#* Creating Effective Information Architecture
#* [[CompFAQ/Digital Writing/Design/Users|What is “user-centered design”?]]
#* [[CompFAQ/Digital Writing/Design/Responsive|What is “responsive design”?]]
#* [[CompFAQ/Digital Writing/Information Architecture|What is “information architecture”?]]
#* [[CompFAQ/Digital Writing/Actionable Content|What is a “actionable content”?]]
# Additional Reading (choose one)
#* “Designing Places and Spaces” — chapter 5 of {{harvtxt|Carroll|2010}}
#* “Identify Your Audience” — chapter 2; “Be Inclusive, Write for the World” — chapter 5 of {{harvtxt|Barr|2010}}
#* “Document Design” — chapter 4 of {{harvtxt|Balzotti|2022}}
# Post: Designing User-Centric Digital Content
# Post: Designing User-Centric Digital Content
# Reading: "Don't Make Me Think" by Steve Krug and "Information Architecture: For the Web and Beyond" by Louis Rosenfeld and Peter Morville
# Reading: "Don't Make Me Think" by Steve Krug and "Information Architecture: For the Web and Beyond" by Louis Rosenfeld and Peter Morville
Line 48: Line 75:
==6: Usability, Accessibility, and SEO==
==6: Usability, Accessibility, and SEO==
# The Importance of Usability in Digital Writing
# The Importance of Usability in Digital Writing
#* Ensuring Accessibility and SEO Best Practices
#* [[CompFAQ/Digital Writing/Usability|What is “usability”?]]
#* [[CompFAQ/Digital Writing/Scannability|What is “scannability”?]]
#* [[CompFAQ/Digital Writing/Accessibility|What is “accessibility”?]]
#* [[CompFAQ/Digital Writing/SEO|What is “SEO” and how do I use it effectively?]]
# Additional Reading (choose at least one)
#* “Speak to Your Entire Audience” — section II of {{harvtxt|Barr|2010}}
#* “Optimize Your Site for Search Engines” — chapter 17 of {{harvtxt|Barr|2010}}
# Post: Balancing Accessibility and SEO Optimization
# Post: Balancing Accessibility and SEO Optimization
# Reading: "Usability Engineering" by Jakob Nielsen and "Search Engine Optimization All-in-One For Dummies" by Bruce Clay
# Reading: "Usability Engineering" by Jakob Nielsen and "Search Engine Optimization All-in-One For Dummies" by Bruce Clay
Line 54: Line 87:
==7: Citing Sources and Effective Use of Links==
==7: Citing Sources and Effective Use of Links==
# Proper Citation in Digital Documents
# Proper Citation in Digital Documents
#* Incorporating Links for Enhanced Content
#* [[CompFAQ/Digital Writing/Sourcing|How do I cite sources in digital documents?]]
#* [[CompFAQ/Digital Writing/Links|How do I use links effectively?]]
# Post: Ethical Considerations in Linking and Citation
# Post: Ethical Considerations in Linking and Citation
# Reading: "MLA Handbook" by The Modern Language Association and "The Hyperlinked Society" by Joseph Turow
# Reading: "MLA Handbook" by The Modern Language Association and "The Hyperlinked Society" by Joseph Turow


{{Line}}
===Bibliography===
===Bibliography===
The following texts are available either on Archive.org or in the [https://files.grlucas.com/d/14accad318864eef8afb/ ENGL 5106 Library] on my server (see D2L for the password).
The following texts are available either on Archive.org or in the [https://files.grlucas.com/d/14accad318864eef8afb/ ENGL 5106 Library] on my server (see D2L for the password).
{{Refbegin|20em|indent=yes}}
{{Refbegin|20em|indent=yes}}
* {{cite book |last=Arnold |first=George T. |date={{date|2013}} |title=Media Writer's Handbook: A Guide to Common Writing and Editing Problems |url= |location=New York |publisher=McGraw Hill |ref=harv }}
* {{cite book |last=Balzotti |first=John |date={{date|2022}} |title=Technical Communication: A Design-Centric Approach |url= |location=New York |publisher=Routledge |ref=harv }}
* {{cite book |last=Balzotti |first=John |date={{date|2022}} |title=Technical Communication: A Design-Centric Approach |url= |location=New York |publisher=Routledge |ref=harv }}
* {{cite book |last=Barr |first=Chris |date={{date|2010}} |title=Yahoo! Style Guide |url= |location=New York |publisher=St. Martin's |ref=harv }}
* {{cite book |last=Carroll |first=Brian |date={{date|2010}} |title=Writing for Digital Media |url= |location=New York |publisher=Routledge |ref=harv }}
* {{cite book |last1=DeVoss |first1=Dànielle Nicole |last2=Eidman-Aadahl |first2=Elyse |last3=Hicks |first3=Troy |date={{date|2010}} |title=Because Digital Writing Matters |url= |location=New York |publisher=Josey-Bass |ref=harv }}
* {{cite book |last=Johnson-Sheehan |first=Richard |date={{date|2018}} |title=Technical Communication Today |edition=Sixth |url= |location=New York |publisher=Pearson |ref=harv }}
* {{cite book |last=Johnson-Sheehan |first=Richard |date={{date|2018}} |title=Technical Communication Today |edition=Sixth |url= |location=New York |publisher=Pearson |ref=harv }}
* {{cite book |last1=Lannon |first1=John M. |last2=Gurak |first2=Laura J. |date={{date|2022}} |title=Technical Communication |edition=Fifteenth |url= |location=New York |publisher=Pearson |ref=harv }}
* {{cite book |last1=Lannon |first1=John M. |last2=Gurak |first2=Laura J. |date={{date|2022}} |title=Technical Communication |edition=Fifteenth |url= |location=New York |publisher=Pearson |ref=harv }}

Revision as of 13:17, 25 September 2023

Technical Writing in the Digital Age: A Coursebook

Directions: For each lesson below, follow all links and read them carefully. All assigned readings not linked may be found on my server or in your assigned textbook. See your individual syllabus for due dates and additional instructions.

1: Understanding Technical Writing in the Digital Age

  1. Defining “Technical Writing” and Its Evolution
  2. Additional Reading (choose one to read)
  3. To Do: Establishing Your Professional Persona
  4. Post: Introduce yourself and the professional, or discourse, community that you will represent in your writing this semester and/or perhaps in the future as a professional. What is your understanding of “technical writing in the digital age” at this point? What did you glean from your reading? Which seem most applicable to your interests as a digital writer? The project above asks you to announce your new domain name; you may do that in this post. (750–1000 words)

2: Strong Writing, Digital Literacy, and Credibility

  1. String Writing & Digital Literacy: What They Entail
  2. Additional Reading (choose at least one)
  3. Post: Evaluating Digital Literacy in Technical Writing
  4. Reading: "Writing and Community Engagement: A Critical Sourcebook" edited by Thomas Deans and "Digital Literacy for Technical Communication" by Rachel Spilka

3: Style and Tone in Digital Writing

  1. Style Guidelines for Digital Writing
  2. Additional Reading (choose one)
  3. Post: Crafting Effective Digital Messages
  4. Reading: "Style: Lessons in Clarity and Grace" by Joseph M. Williams and "The Elements of Style" by William Strunk Jr. and E.B. White

4: Digital Documents and Remediation

  1. Digital vs. Paper Documents: Key Differences
  2. Additional Reading (choose one)
    • “Screen Writing: Online Style and Techniques” — chapter 3 of Carroll (2010)
    • “Headlines and Hypertext” — chapter 4 of Carroll (2010)
    • “Write Clear User-Interface Text” — chapter 7 of Barr (2010)
    • “Design-Centric Communication” — chapter 2 of Balzotti (2022)
  3. Post: Analyzing Digital Document Transformations
  4. Reading: "Remediation: Understanding New Media" by Jay David Bolter and Richard Grusin and "Writing for the Web" by Lynda Felder

5: User-Centered Design and Information Architecture

  1. Principles of User-Centered Design
  2. Additional Reading (choose one)
    • “Designing Places and Spaces” — chapter 5 of Carroll (2010)
    • “Identify Your Audience” — chapter 2; “Be Inclusive, Write for the World” — chapter 5 of Barr (2010)
    • “Document Design” — chapter 4 of Balzotti (2022)
  3. Post: Designing User-Centric Digital Content
  4. Reading: "Don't Make Me Think" by Steve Krug and "Information Architecture: For the Web and Beyond" by Louis Rosenfeld and Peter Morville

6: Usability, Accessibility, and SEO

  1. The Importance of Usability in Digital Writing
  2. Additional Reading (choose at least one)
    • “Speak to Your Entire Audience” — section II of Barr (2010)
    • “Optimize Your Site for Search Engines” — chapter 17 of Barr (2010)
  3. Post: Balancing Accessibility and SEO Optimization
  4. Reading: "Usability Engineering" by Jakob Nielsen and "Search Engine Optimization All-in-One For Dummies" by Bruce Clay

7: Citing Sources and Effective Use of Links

  1. Proper Citation in Digital Documents
  2. Post: Ethical Considerations in Linking and Citation
  3. Reading: "MLA Handbook" by The Modern Language Association and "The Hyperlinked Society" by Joseph Turow



Bibliography

The following texts are available either on Archive.org or in the ENGL 5106 Library on my server (see D2L for the password).

  • Arnold, George T. (2013). Media Writer's Handbook: A Guide to Common Writing and Editing Problems. New York: McGraw Hill.
  • Balzotti, John (2022). Technical Communication: A Design-Centric Approach. New York: Routledge.
  • Barr, Chris (2010). Yahoo! Style Guide. New York: St. Martin's.
  • Carroll, Brian (2010). Writing for Digital Media. New York: Routledge.
  • DeVoss, Dànielle Nicole; Eidman-Aadahl, Elyse; Hicks, Troy (2010). Because Digital Writing Matters. New York: Josey-Bass.
  • Johnson-Sheehan, Richard (2018). Technical Communication Today (Sixth ed.). New York: Pearson.
  • Lannon, John M.; Gurak, Laura J. (2022). Technical Communication (Fifteenth ed.). New York: Pearson.
  • Tham, Jason C. K. (2021). Design Thinking in Technical Communication: Solving Problems through Making and Collaboration. New York: Routledge.
Written: 2002, 2022; Revised: 09-25-2023; Version: Beta 0.7 💬