
Technical Document Analysis
Skills
• Analyze
• Memo writing
• Usability testing
Narration
In TWC 401, a course dedicated to teaching students about the fundamentals of technical communication, one had to choose a technical document to assess its usability. As a former graphic design student, I decided to choose the Adobe Illustrator basics user guide.
With no experience prior to conducting a usability test, this was a learning curve. By looking at the guide through the lens as a first-time user of Adobe Illustrator, it was easier to pinpoint which things would have been confusing. Breaking down the improvements that needed to be made into categories, such as “Support” and “Graphics” made the process much easier, especially when it came to writing recommendations. The assignment was written in the form of a memo, so it was as if I was writing to Adobe and was a part of their team. I improved on my professional writing skills with this analysis, as well as learning how to properly conduct a usability test for a technical document.
Technical Document Revision
Skills
• Revision
• Editing
• Microsoft Word (formatting and inserting images)
Narration
After analyzing our chosen technical document, we then had to revise the document with the recommendations we made. I wasn’t sure how to do the revision, but I ended up copying and pasting everything onto a word document and going from there. Some of the recommendations given were concerning the images used in the user guide. While these were supposed to help the user understand what the text in the guide was referring to, they were not clear enough. Therefore, the images needed to be redone or edited. This assignment required me to thoroughly go through the entire document and make sure every detail was improved. The revision helped me learn how useful and important it was to design a document with a specific audience in mind.