This project asks you to write a formal memo that contains a detailed proposal on what [you will do], when [you will do it], and how [you will do it] for your work in the semester. You should identify the grade you want to earn with a concrete plan for accomplishing that goal.

Transcript

Your project will be graded on the following required elements:

You are also graded on the work's overall polish, editing, and professional impact.

This episode describes what I was looking for in the Usability Report assignment to help you reflect on your grade.

The project asked you to:

Submit a pdf between 15-25* single-spaced pages with all the standards of a formal report. 

Letter of Transmittal to Client

Front Matter

Usability Report Sections

Back Matter-

*The document is longer because you add your testing materials and data scorecards. The content itself is ~4,000 words.

An early step in the writing process (and most professional/technical projects) is developing a plan that captures your ideas, and it is common for stakeholders to request progress reports on the work. Project plans and progress reports promote transparency, accountability, and informed decision-making, ultimately leading to successful project outcomes.

I expect documentation on your work so far- with actual progress being made- and a literal plan you can follow to complete the class with the grade you want/need. Your plan must include language, details, dates, and action items for the remaining projects you intend to complete. 

This voice note reflects on the expectations for a functional to very effective instructional eBooklet project.

You were asked to create a digital booklet that guides your readers through the step-by-step process of completing your chosen task. The goal is to practice your technical writing skills by presenting clear, concise, and easy-to-follow instructions. Your digital eBooklet should be visually appealing, incorporating images, diagrams, and special tips/notes to enhance the learning experience. The eBooklet will be a comprehensive resource, providing detailed step-by-step instructions, relevant visuals, and a troubleshooting table.

This project asks you to create a reference library using a wiki software for a company to organize technical descriptions about industry topics.

Transcript

Your project will be graded on the following requirements:

A formal memo as your project retrospective that details:

-Work Assessment: how you met the objectives of the project

-Process Reflection: why you made your creative choices and solved problems during the project

-Applications: how the skills, technology, and experiences from this project will help you improve as a professional in your field

A wiki home page that provides

-Welcome: the purpose and orientation of the library you've created, including its branding

-Software Description: how the wiki software works so their employees understand the tool

-Best Practices: for writing technical descriptions so their employees can add quality entries on their own

An entry for a piece of equipment relevant to the company that models

-Extended Definition: the type, class, and features that distinguish the equipment

-Mechanical Functions: a detailed explanation of how the components work as a system

-Specifications: a list of the color, material, weight, dimensions, and other relevant specs

An entry for a non-instructional technical process (select a chemical, biological, physics, electrical circuit, or environmental process) relevant to the company that models:

-Extended Definition: the type, class, and stages that distinguish the process

-Sequencing: a detailed explanation of how the process completes and functions as a system

-Outcomes: an overview of the output generated by the process sequence

One type of each visual with a caption and proper copyright considerations

-Photo, Rendering, or Illustration

-Table

-Diagram or Flowchart

You must include polished writing, visuals, and design throughout the sections.

Hey associates, this lecture is an introduction to document design as part of your larger visual strategy when presenting technical information to the reader. The emphasis on the design–the overall layout, color, and font choices on a document–is one of the key qualities of “information design.”

The lecture has three sections:

Read the Transcript/Chapter

Use the Notes Guide

Hey associates, this lecture is an introduction to presenting instructions and various command-focused documents in technical writing. It is those step-by-step explanations of how to do things with strong, commanding verbs: assemble, operate, repair. Today's content focuses on building more useful, useable, and enjoyable commands and instructions for your readers to accomplish the tasks.

Transcript Chapter

Hey associates, this lecture is about technical graphics used in professional, business, and technical documents.

The lecture has three sections:

⁠⁠Follow the notetaking guide⁠⁠

⁠⁠Read the Transcript/Textbook Chapter

Notetaking Guide: Slide Deck

Hey associates, this lecture introduces structure and editing for technical documents, especially when you need to describe content to specific audiences…which is our “thing” in technical, business, and end-user communication.

Read the transcript as a book chapter.

Notetaking Guide: Slide Deck