CompFAQ/WritDM: Difference between revisions

From Gerald R. Lucas
(Added more.)
(More work.)
Line 3: Line 3:
{{Large|Technical Writing in the Digital Age: A Coursebook}}
{{Large|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 [[ENGL 5106|individual syllabus]] for due dates and additional instructions.''
''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 [[ENGL 5106|individual syllabus]] for due dates and additional instructions. Please read ahead to know what you are responsible for each week. She lessons will have less work, but others, like Lesson 7, have more work to do.''


==1: Understanding Technical Writing in the Digital Age==
==1: Understanding Technical Writing in the Digital Age==
Line 16: Line 16:
#* “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}}
#* “The Landscape of Digital Writing” — chapter 1 in {{harvtxt|DeVoss|Eidman-Aadahl|Hicks|2010}}
# Project: Begin [[ENGL 5106/Establishing Your Professional Persona|Establishing Your Professional Persona]]
# Post: What is your understanding of “technical writing in the digital age” at this point? What did you glean from your reading? What did you discover that you didn’t know? Which seem most applicable to your interests as a digital writer? (750–1000 words #techwriting){{refn|For journal posts, assigned topics will include at least one keyword that you should use on your post.}}
# Post: What is your understanding of “technical writing in the digital age” at this point? What did you glean from your reading? What did you discover that you didn’t know? Which seem most applicable to your interests as a digital writer? (750–1000 words #techwriting){{refn|For journal posts, assigned topics will include at least one keyword that you should use on your post.}}


Line 32: Line 33:
#* “Ethics” — chapter 5 of {{harvtxt|Balzotti|2022}}
#* “Ethics” — chapter 5 of {{harvtxt|Balzotti|2022}}
#* “Introduction to Digital Writing” — chapter 1 of {{harvtxt|Lawrence|2022}}
#* “Introduction to Digital Writing” — chapter 1 of {{harvtxt|Lawrence|2022}}
# To Do: [[ENGL 5106/Establishing Your Professional Persona|Establishing Your Professional Persona]]
# Project: [[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. Introduce your technical writing persona. What strategies will you use to build your persona’s credibility? The project above asks you to announce your new domain name; you should do that in this post. Support your ideas with specific evidence. Comment on a colleague’s post. (750–100 words #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. Introduce your technical writing persona. What strategies will you use to build your persona’s credibility? The project above asks you to announce your new domain name; you should do that in this post. Support your ideas with specific evidence. Comment on a colleague’s post. (750–100 words #persona)


Line 42: Line 43:
#* “Write for the Web” — chapter 1; “Define Your Voice” — chapter 3 of {{harvtxt|Barr|2010}}
#* “Write for the Web” — chapter 1; “Define Your Voice” — chapter 3 of {{harvtxt|Barr|2010}}
#* “Style” — chapter 3 of {{harvtxt|Balzotti|2022}}
#* “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}}
#* “Revising the Writing Process” — chapter 2 in {{harvtxt|DeVoss|Eidman-Aadahl|Hicks|2010}}
#* “Writing for the Web” — chapter 3 in {{harvtxt|Lawrence|2022}}
#* “Writing for the Web” — chapter 3 in {{harvtxt|Lawrence|2022}}
#* “Editing for a Professional Style and Tone” — chapter 11 of {{harvtxt|Lannon|Gurak|2022}}
#* “Editing for a Professional Style and Tone” — chapter 11 of {{harvtxt|Lannon|Gurak|2022}}
#* “Writing for Your Readers” — chapter 6 of {{harvtxt|Markel|Selber|2019}}
#* “Writing for Your Readers” — chapter 6 of {{harvtxt|Markel|Selber|2019}}
# Post: Crafting Effective Digital Messages
#* “Style as Choice” — chapter 1 of {{harvtxt|Williams|2000}}
# Project:
# Post:  
# 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 62: Line 65:
#* “Designing Visual Information” — chapter 12 of {{harvtxt|Lannon|Gurak|2022}}
#* “Designing Visual Information” — chapter 12 of {{harvtxt|Lannon|Gurak|2022}}
#* “Digital-Visual Style” — chapter 4 in {{harvtxt|Lawrence|2022}}
#* “Digital-Visual Style” — chapter 4 in {{harvtxt|Lawrence|2022}}
# Post: Analyzing Digital Document Transformations
# Project: [[CompFAQ/Digital Writing/Remediation#Exercise|Remediation Challenge]]
# Post:  
# 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 78: Line 82:
#* “Persuading Your Audience” — chapter 3 of {{harvtxt|Lannon|Gurak|2022}}
#* “Persuading Your Audience” — chapter 3 of {{harvtxt|Lannon|Gurak|2022}}
#* “Analyzing Your Audience and Purpose — chapter 3 of {{harvtxt|Markel|Selber|2019}}
#* “Analyzing Your Audience and Purpose — chapter 3 of {{harvtxt|Markel|Selber|2019}}
# Post: Designing User-Centric Digital Content
#* “Defining Information Architecture” — chapter 2 of {{harvtxt|Rosenfeld|Morville|Arango|2015}}
# Project:
# Post:  
# 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 91: Line 97:
#* “Optimize Your Site for Search Engines” — chapter 17 of {{harvtxt|Barr|2010}}
#* “Optimize Your Site for Search Engines” — chapter 17 of {{harvtxt|Barr|2010}}
#* “Designing Print and Online Documents” — chapter 7 of {{harvtxt|Markel|Selber|2019}}
#* “Designing Print and Online Documents” — chapter 7 of {{harvtxt|Markel|Selber|2019}}
# Post: Balancing Accessibility and SEO Optimization
#* “Responsive Web Design” — chapter 17 of {{harvtxt|Robbins|2018}}
# Project:
# Post:  
# 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 100: Line 108:
# Additional Reading (choose at least one)
# Additional Reading (choose at least one)
#* “Thinking Critically about the Research Process” — chapter 7 of {{harvtxt|Lannon|Gurak|2022}}
#* “Thinking Critically about the Research Process” — chapter 7 of {{harvtxt|Lannon|Gurak|2022}}
# Post: Ethical Considerations in Linking and Citation
# Project: [[ENGL 5106/Collaborative Wiki Project|Collaborative Wiki Project]]
# Post:  
# 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}}
{{Line}}
Line 117: Line 125:
* {{cite book |last=Lawrence |first=Dan |date={{date|2022}} |title=Digital Writing: A Guide to Writing for Social Media and the Web |url= |location= |publisher=Broadview Press |ref=harv }}
* {{cite book |last=Lawrence |first=Dan |date={{date|2022}} |title=Digital Writing: A Guide to Writing for Social Media and the Web |url= |location= |publisher=Broadview Press |ref=harv }}
* {{cite book |last1=Markel |first1=Mike |last2=Selber |first2=Stuart A. |date={{date|2019}} |title=Practical Strategies for Technical Communication |url= |location=Boston, MA |publisher=Bedford/St. Martins |ref=harv }}
* {{cite book |last1=Markel |first1=Mike |last2=Selber |first2=Stuart A. |date={{date|2019}} |title=Practical Strategies for Technical Communication |url= |location=Boston, MA |publisher=Bedford/St. Martins |ref=harv }}
* {{cite book |last=Robbins |first=Jennifer Niederst |date={{date|2018}} |title=Learning Web Design |url= |location=Sebastopol, CA |publisher=O'Reilly |ref=harv }}
* {{cite book |last1=Rosenfeld |first1=Louis |last2=Morville |first2=Peter |last3=Arango |first3=Jorge  |date={{date|2015}} |title=Information Architecture: For the Web and Beyond |url= |location=Sebastopol, CA |publisher=O'Reilly |ref=harv }}
* {{cite book |last=Tham |first=Jason C. K. |date={{date|2021}} |title=Design Thinking in Technical Communication: Solving Problems through Making and Collaboration |url= |location=New York |publisher=Routledge |ref=harv }}
* {{cite book |last=Tham |first=Jason C. K. |date={{date|2021}} |title=Design Thinking in Technical Communication: Solving Problems through Making and Collaboration |url= |location=New York |publisher=Routledge |ref=harv }}
* {{cite book |last=Williams |first=Joseph M. |date={{date|2000}} |title=Style: Ten Lessons in Clarity and Grace |url= |location=New York |publisher=Longman |ref=harv }}
{{Refend}}
{{Refend}}



Revision as of 16:22, 27 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. Please read ahead to know what you are responsible for each week. She lessons will have less work, but others, like Lesson 7, have more work to do.

1: Understanding Technical Writing in the Digital Age

  1. Defining “Technical Writing” and Its Evolution
  2. Additional Reading (choose one to read)
  3. Project: Begin Establishing Your Professional Persona
  4. Post: What is your understanding of “technical writing in the digital age” at this point? What did you glean from your reading? What did you discover that you didn’t know? Which seem most applicable to your interests as a digital writer? (750–1000 words #techwriting)[1]

2: Strong Writing, Digital Literacy, and Credibility

  1. Strong Writing & Digital Literacy: What They Entail
  2. Additional Reading (choose at least one)
  3. Project: 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. Introduce your technical writing persona. What strategies will you use to build your persona’s credibility? The project above asks you to announce your new domain name; you should do that in this post. Support your ideas with specific evidence. Comment on a colleague’s post. (750–100 words #persona)

3: Style and Tone in Digital Writing

  1. Style Guidelines for Digital Writing
  2. Additional Reading (choose two)
  3. Project:
  4. Post:
  5. 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)
  3. Project: Remediation Challenge
  4. Post:
  5. 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)
  3. Project:
  4. Post:
  5. 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)
  3. Project:
  4. Post:
  5. 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. Additional Reading (choose at least one)
  3. Project: Collaborative Wiki Project
  4. Post:
  5. 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.
  • Lawrence, Dan (2022). Digital Writing: A Guide to Writing for Social Media and the Web. Broadview Press.
  • Markel, Mike; Selber, Stuart A. (2019). Practical Strategies for Technical Communication. Boston, MA: Bedford/St. Martins.
  • Robbins, Jennifer Niederst (2018). Learning Web Design. Sebastopol, CA: O'Reilly.
  • Rosenfeld, Louis; Morville, Peter; Arango, Jorge (2015). Information Architecture: For the Web and Beyond. Sebastopol, CA: O'Reilly.
  • Tham, Jason C. K. (2021). Design Thinking in Technical Communication: Solving Problems through Making and Collaboration. New York: Routledge.
  • Williams, Joseph M. (2000). Style: Ten Lessons in Clarity and Grace. New York: Longman.



notes

  1. For journal posts, assigned topics will include at least one keyword that you should use on your post.
Written: 2002, 2022; Revised: 09-27-2023; Version: Beta 0.7 💬