User Documentation Revision & Reflection Memo
- Due Sep 29, 2023 by 11:59pm
- Points 1
- Submitting a website url or a file upload
- File Types pdf
- Available Aug 21, 2023 at 12am - Dec 1, 2023 at 11:59pm
Rubric
Find RubricKeep in mind that 2 students have already been assessed using this rubric. Changing it will affect their evaluations.
| Criteria | Ratings | ||||
|---|---|---|---|---|---|
|
My project revises an existing piece of user documentation that was originally a webpage or PDF with instructions that college students at Virginia Tech would use.
|
|
||||
|
My project revises convoluted, overly formal, and confusing language with plain, simple language.
See the Resource Module: Plain Language at https://canvas.vt.edu/courses/177045/modules/397307
|
|
||||
|
My project applies design principles to the document, including a title and internal headings, to approve its readability.
See the Resource Module: Document Design at https://canvas.vt.edu/courses/177045/modules/397301
|
|
||||
|
My project addresses all ethical considerations to ensure that the user documentation is honest, inclusive, and accessible.
See the Resource Module: Ethics in Technical Writing at https://canvas.vt.edu/courses/177045/modules#module_414585
|
|
||||
|
My project ensures that legal disclaimers and policies are clear and legible and that citations are used properly.
See the Resource Module: Ethics in Technical Writing at https://canvas.vt.edu/courses/177045/modules#module_414585
|
|
||||
|
My project adapts the content for multiple readers, including international readers.
See Resource Module: Intercultural Communication at https://canvas.vt.edu/courses/177045/modules/397304
|
|
||||
|
My project is submitted as a PDF with your revised layout and design represented accurately.
|
|
||||
|
My reflection memo begins with required memo headers.
See the Resource Module: Correspondence at https://canvas.vt.edu/courses/177045/modules/397300
|
|
||||
|
My reflection memo uses a clear and specific subject line for the memo.
See the Strong Subject Lines page at https://canvas.vt.edu/courses/177045/pages/strong-subject-lines
|
|
||||
|
My reflection memo introduces the user documentation, providing a link to the original version, and ending with a purpose statement.
See the Organization: Writing Elements & Organization page at https://canvas.vt.edu/courses/177045/pages/organization-writing-elements-and-organization
|
|
||||
|
My reflection memo includes a section on Plain Language Revision section that evaluates the original document’s usability in terms of its writing and that discusses the language with examples of the original design and my revision.
See the Resource Module: Plain Language at https://canvas.vt.edu/courses/177045/modules/397307
|
|
||||
|
My reflection memo includes a section on Redesign that evaluates the original document’s usability in terms of design and that discusses the design with examples of design principles that are broken in the original document and the revisions that you made to improve the document.
See the Resource Module: Document Design at https://canvas.vt.edu/courses/177045/modules/397301
|
|
||||
|
My reflection memo includes a section on Ethical, Legal, and Cultrual Considerations that evaluates the original document’s ethical, legal, and cultural considerations, indicating any considerations that are excluded and providing examples from the original document and your revisions that improve the document in these areas.
See the Resource Module: Ethics in Technical Writing at https://canvas.vt.edu/courses/177045/modules#module_414585 and the Resource Module: Intercultural Communication at https://canvas.vt.edu/courses/177045/modules/397304
|
|
||||
|
My reflection memo includes a section on Rhetorical Analysis that introduces the changes you made to improve the document’s ability to connect with its audience.
See Ch 1.3: Understanding the Rhetorical Situation at https://pressbooks.bccampus.ca/technicalwriting/chapter/understandingrhetoricalsituation/
Links to an external site.
|
|
||||
|
My reflection memo ends with a conclusion that reviews your evaluation of the original document and summarizes how your changes have improved the document, as well as provides contact information.
|
|
||||
|
My reflection memo uses standard memo format and document design, with appropriate spacing, headings, and page numbers.
See the Resource Module: Correspondence at https://canvas.vt.edu/courses/177045/modules/397300
|
|
||||
|
|
|||||
