(First save.) |
m (→1: Understanding Technical Writing in the Digital Age: Updated note.) |
||
| (11 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{:CompFAQ/Tabs}} | {{:CompFAQ/Tabs}} | ||
{{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. 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== | ||
# What digital | # Defining “Technical Writing” and Its Evolution | ||
#* | #* [[CompFAQ/Technical Writing|What is “technical writing”?]] | ||
#* [[CompFAQ/Digital Writing|What is “digital writing”?]] | |||
#* [[CompFAQ/Digital Writing/Tech Writing|What is “technical writing in the digital age”?]] | |||
# Additional Reading (choose one to read) | |||
#* “What Is Technical Communication?” — chapter 1 of {{harvtxt|Balzotti|2022}} | |||
#* “Technical Communication in the Entrepreneurial Workplace” — chapter 1 of {{harvtxt|Johnson-Sheehan|2018}} | |||
#* “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}} | |||
#* “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]] | |||
# Journal Post:{{refn|All journal posts will be on the [[ENGL 5106/Research and Process Journal|class journal/blog]].}} 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, or tag, that you should use on your post. See the [https://ghost.org/help/tags/ Ghost Manual » Tags] for more.}} | |||
== | ==2: Strong Writing, Digital Literacy, and Credibility== | ||
# | # Strong Writing & Digital Literacy: What They Entail | ||
#* | #* [[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”?]] | |||
#* [[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/Domain|How do I register a domain name?]] | |||
# 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}} | |||
#* “Introduction to Digital Writing” — chapter 1 of {{harvtxt|Lawrence|2022}} | |||
# 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) | |||
== | ==3: Style and Tone in Digital Writing== | ||
# | # Style Guidelines for Digital Writing | ||
#* | #* [[CompFAQ/Digital Writing/Style|Should digital writing use a particular style?]] | ||
# Additional Reading (choose two) | |||
#* “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” — chapter 2 in {{harvtxt|DeVoss|Eidman-Aadahl|Hicks|2010}} | |||
#* “Writing for the Web” — chapter 3 in {{harvtxt|Lawrence|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}} | |||
#* “Style as Choice” — chapter 1 of {{harvtxt|Williams|2000}} | |||
# Post: Find a website that represents or is associated with your discourse community. Ensure it’s a site with significant written content. Examine the tone, language, and clarity of the content. Consider the target audience and the effectiveness of the writing style. Assess the layout, color scheme, typography, and overall visual appeal. Analyze how design choices contribute to user engagement and accessibility. Post a concise report that summarizes your findings. Include specific examples from the website to support your analysis. (500–750 words #webanalysis) | |||
== | ==4: Digital Documents and Remediation== | ||
# Digital vs. Paper Documents: Key Differences | |||
#* [[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}} | |||
#* “Designing Visual Information” — chapter 12 of {{harvtxt|Lannon|Gurak|2022}} | |||
#* “Digital-Visual Style” — chapter 4 in {{harvtxt|Lawrence|2022}} | |||
#* “All You really Need to Know” and “Best Practices” — chapters 1 and 2 in {{harvtxt|Felder|2012}} | |||
# Project: [[CompFAQ/Digital Writing/Remediation#Exercise|Remediation Challenge]] | |||
# Post: Outlined in the project. (≈500 words #remediation) | |||
== | ==5: User-Centered Design and Information Architecture== | ||
# Principles of User-Centered Design | |||
#* [[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}} | |||
#* “Meeting the Needs of Specific Audiences” — chapter 2 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}} | |||
#* “Defining Information Architecture” — chapter 2 of {{harvtxt|Rosenfeld|Morville|Arango|2015}} | |||
# Project: [[CompFAQ/Digital Writing/Information Architecture#Exercise|Analyzing Information Architecture in Web Design]] | |||
# Post: Outlined in the project. Be sure to comment on another post. (750–1000 words #ia) | |||
== | ==6: Usability, Accessibility, and SEO== | ||
# The Importance of Usability in Digital Writing | |||
#* [[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) | |||
#* “Don’t Make Me Think” — chapter 1 of {{harvtxt|Krug|2014}} | |||
#* “Speak to Your Entire Audience” — section II 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}} | |||
#* “Responsive Web Design” — chapter 17 of {{harvtxt|Robbins|2018}} | |||
# Project: [[CompFAQ/Digital Writing/SEO#Exercise|Developing Your SEO Strategy]] | |||
# Post: Reflect on the SEO strategy you’ve developed in your project. Consider how each component of the strategy aligns with your project’s goals and target audience. Identify any potential challenges or areas for improvement. You needn’t post the whole SEO strategy; this is more of a reflection on the ''process'' and ''application'' of SEO. (≈500 words #seo) | |||
==7: Citing Sources and Effective Use of Links== | |||
# Proper Citation in Digital Documents | |||
#* [[CompFAQ/Digital Writing/Sourcing|How do I cite sources in digital documents?]] | |||
#* [[CompFAQ/Digital Writing/Links|How do I use links effectively?]] | |||
# Additional Reading (choose at least one) | |||
#* “Thinking Critically about the Research Process” — chapter 7 of {{harvtxt|Lannon|Gurak|2022}} | |||
# Project: [[ENGL 5106/Collaborative Wiki Project|Collaborative Wiki Project]] | |||
# Post: Outline your contributions and experience in writing the collaborative wiki article. Include a summary of your edits and why you felt they were a valuable addition to the article. How does your article compare to earlier versions? What did you learn from contributing to LitWiki? How can wikis be used to improve public understanding of our field/your topic? Why is this important? (≈500 words #wiki) | |||
===Bibliography=== | |||
The following texts are available either on Archive.org (the linked sources) or in the [https://files.grlucas.com/d/14accad318864eef8afb/ ENGL 5106 Library] on my server (see D2L for the password). | |||
{{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=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=Felder |first=Lynda |date={{date|2012}} |title=Writing for the Web: Creating Compelling Web Content Using Words, Pictures and Sound |url= |location=Berkeley, CA |publisher=New Riders |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=Krug |first=Steve |date={{date|2014}} |title=Don’t Make Me Think, Revisited |url= |location=Berkeley, CA |publisher=New Riders |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 |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 |last=Nielsen |first=Jakob |date={{date|1993}} |title=Usability Engineering |url=https://archive.org/details/usabilityenginee0000niel |location=Boston, MA |publisher=Academic Press |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=Williams |first=Joseph M. |date={{date|2000}} |title=Style: Ten Lessons in Clarity and Grace |url= |location=New York |publisher=Longman |ref=harv }} | |||
{{Refend}} | |||
{{Notes}} | |||
{{CompFAQ-foot}} | {{CompFAQ-foot}} | ||
{{DEFAULTSORT:ENGL 5106}} | {{DEFAULTSORT:ENGL 5106}} | ||
[[Category: Index (FAQ)]] | [[Category: Index (FAQ)]] | ||
Latest revision as of 10:01, 2 November 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
- Defining “Technical Writing” and Its Evolution
- Additional Reading (choose one to read)
- “What Is Technical Communication?” — chapter 1 of Balzotti (2022)
- “Technical Communication in the Entrepreneurial Workplace” — chapter 1 of Johnson-Sheehan (2018)
- “Introduction to Technical Communication” — chapter 1 of Lannon & Gurak (2022)
- “Introducing Design Thinking (and Making) for Technical Communication” — chapter 1 of Tham (2021)
- “The Landscape of Digital Writing” — chapter 1 in DeVoss, Eidman-Aadahl & Hicks (2010)
- Project: Begin Establishing Your Professional Persona
- Journal Post:[1] 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)[2]
2: Strong Writing, Digital Literacy, and Credibility
- Strong Writing & Digital Literacy: What They Entail
- Additional Reading (choose at least one)
- “25 Ways to Improve Writing Immediately” — chapter 1 of Arnold (2013)
- “On Writing Well” — chapter 1 of Carroll (2010)
- “Shorten and Strengthen Sentences” — chapter 13 of Barr (2010)
- “Ethics” — chapter 5 of Balzotti (2022)
- “Introduction to Digital Writing” — chapter 1 of Lawrence (2022)
- Project: 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)
3: Style and Tone in Digital Writing
- Style Guidelines for Digital Writing
- Additional Reading (choose two)
- “Digital Media Versus Analog Media” — chapter 2 of Carroll (2010)
- “Write for the Web” — chapter 1; “Define Your Voice” — chapter 3 of Barr (2010)
- “Style” — chapter 3 of Balzotti (2022)
- “Revising the Writing Process” — chapter 2 in DeVoss, Eidman-Aadahl & Hicks (2010)
- “Writing for the Web” — chapter 3 in Lawrence (2022)
- “Editing for a Professional Style and Tone” — chapter 11 of Lannon & Gurak (2022)
- “Writing for Your Readers” — chapter 6 of Markel & Selber (2019)
- “Style as Choice” — chapter 1 of Williams (2000)
- Post: Find a website that represents or is associated with your discourse community. Ensure it’s a site with significant written content. Examine the tone, language, and clarity of the content. Consider the target audience and the effectiveness of the writing style. Assess the layout, color scheme, typography, and overall visual appeal. Analyze how design choices contribute to user engagement and accessibility. Post a concise report that summarizes your findings. Include specific examples from the website to support your analysis. (500–750 words #webanalysis)
4: Digital Documents and Remediation
- Digital vs. Paper Documents: Key Differences
- 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)
- “Designing Visual Information” — chapter 12 of Lannon & Gurak (2022)
- “Digital-Visual Style” — chapter 4 in Lawrence (2022)
- “All You really Need to Know” and “Best Practices” — chapters 1 and 2 in Felder (2012)
- Project: Remediation Challenge
- Post: Outlined in the project. (≈500 words #remediation)
5: User-Centered Design and Information Architecture
- Principles of User-Centered Design
- 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)
- “Meeting the Needs of Specific Audiences” — chapter 2 of Lannon & Gurak (2022)
- “Persuading Your Audience” — chapter 3 of Lannon & Gurak (2022)
- “Analyzing Your Audience and Purpose — chapter 3 of Markel & Selber (2019)
- “Defining Information Architecture” — chapter 2 of Rosenfeld, Morville & Arango (2015)
- Project: Analyzing Information Architecture in Web Design
- Post: Outlined in the project. Be sure to comment on another post. (750–1000 words #ia)
6: Usability, Accessibility, and SEO
- The Importance of Usability in Digital Writing
- Additional Reading (choose at least one)
- “Don’t Make Me Think” — chapter 1 of Krug (2014)
- “Speak to Your Entire Audience” — section II of Barr (2010)
- “Optimize Your Site for Search Engines” — chapter 17 of Barr (2010)
- “Designing Print and Online Documents” — chapter 7 of Markel & Selber (2019)
- “Responsive Web Design” — chapter 17 of Robbins (2018)
- Project: Developing Your SEO Strategy
- Post: Reflect on the SEO strategy you’ve developed in your project. Consider how each component of the strategy aligns with your project’s goals and target audience. Identify any potential challenges or areas for improvement. You needn’t post the whole SEO strategy; this is more of a reflection on the process and application of SEO. (≈500 words #seo)
7: Citing Sources and Effective Use of Links
- Proper Citation in Digital Documents
- Additional Reading (choose at least one)
- “Thinking Critically about the Research Process” — chapter 7 of Lannon & Gurak (2022)
- Project: Collaborative Wiki Project
- Post: Outline your contributions and experience in writing the collaborative wiki article. Include a summary of your edits and why you felt they were a valuable addition to the article. How does your article compare to earlier versions? What did you learn from contributing to LitWiki? How can wikis be used to improve public understanding of our field/your topic? Why is this important? (≈500 words #wiki)
Bibliography
The following texts are available either on Archive.org (the linked sources) 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.
- Felder, Lynda (2012). Writing for the Web: Creating Compelling Web Content Using Words, Pictures and Sound. Berkeley, CA: New Riders.
- Johnson-Sheehan, Richard (2018). Technical Communication Today (Sixth ed.). New York: Pearson.
- Krug, Steve (2014). Don’t Make Me Think, Revisited. Berkeley, CA: New Riders.
- 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.
- Nielsen, Jakob (1993). Usability Engineering. Boston, MA: Academic Press.
- 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
- ↑ All journal posts will be on the class journal/blog.
- ↑ For journal posts, assigned topics will include at least one keyword, or tag, that you should use on your post. See the Ghost Manual » Tags for more.
| Written: 2002, 2022; Revised: 11-2-2023; Version: Beta 0.7 | 💬 |
