Order Number |
30904336790 |
Type of Project |
ESSAY |
Writer Level |
PHD VERIFIED |
Format |
APA |
Academic Sources |
10 |
Page Count |
3-12 PAGES |
Homework: Webfolio (10%)
Students need to individually complete each of the following tasks after revising the relevant textbook pages, provided for each one and submit adding the revised versions of the technical documents they produce in the class time. The aim of the following tasks is to revise basic course principles and to boost the students’ knowledge and skills of technical writing and communication.
Submission will be done through TurnitIn submission.
Submission deadline: 5 Dec, 2019
Student name:_______________
Id number: ____________
Section:______________
Task 1 (15 points):
Redesign the following document to make it more reader-friendly.
Documentation
The formal description of a mechanical system or a technical process is known as its documentation. Documentation takes the form of technical and user manuals that accompany various technological objects, materials, and processes. Electronic hardware, computers, chemicals, automobiles all are accompanied by descriptive documentation in the form of manuals. Two kinds of documentation are required when products are sold: technical documentation and user documentation .
· Technical documentation is a physical description of a system, device, material, or process. This technical description is used by expert users and designers as guidelines to maintain and modify various elements of the system. Good examples of technical documentation are the wiring diagrams that accompany electrical hardware, the computer code that accompanies many programmed instruments, and the detailed pharmaceutical descriptions that accompany various medicines. These descriptions are all intended for experts , who must make informed decisions about the installation, capabilities, modifications, and applications of the technology in question. · User documentation includes the product guidelines addressed to the general user who needs to know basic requirements for getting the best use out of the technology. User documentation includes the manuals for product use, assembly, maintenance, operations, and repair. Manuals should be prepared with the object of making the information quickly available to the expert or general reader. Keep the audience foremost in mind. In manuals, ease of finding and reading information is a priority. Hence manuals should contain these components:
Easy-to-use locating elements, such as tables of contents , indexes , and page headers Useful big-picture and close-up diagrams that make it easy for the reader to become familiar with the technology Effective warnings against personal harm and cautions against harm to the equipment Page designs that lay the material out effectively, with effective labeling, chunking, and white spaces Clear manual arrangements into sections and chapters organized around important tasks Simple, economical style , pared down to just what is needed Consistent, well-designed terminology that keeps the reader focused on the task Effective packages, with binders and covers designed for the working space in which the manual will be used Reference: http://web.mit.edu/course/21/21.guide/docution.htm |
Task 2 (15 points):
Assume that the excerpt of Task 1 is part of a report on Documentation. Write an appropriate conclusion to the report, following the guidelines from page 296 of your textbook (minimum 100 words).
Task 3 (15 points):
Design an effective title page for the report in task 1. Add appropriate font, color and consider alignment and overall layout (p.311)
Task 4 (15 points):
Create a scientific poster on the topic on Documentation. Research to find relevant additional sources (articles, journal articles, books etc.) and add necessary information and/or findings. Add appropriate APA referencing where necessary (check pages 319-20 of your textbook).
Important Note: Additional sources should be derived from AUM Library Database.
Task 5 (20 points):
Include the technical documents that you generated in the class time (all in-class lab tasks).
Task 6 (20 points):
Write a well-organized reflection essay on your work including 5 paragraphs.
Grading Rubric:
NAME: _____________________________ | SECTION: ________ | TOTAL POINTS: ___________ / 100 | ||||
Criteria | Unsatisfactory | Poor | Average | Good | Very Good |
Task #1 (15 points)
Use of the Template: The template is accurately used as provided and free of spelling errors. Content: Question fully answered, with relevant information and minimal repetitions. Theoretical Background: Gradual awareness of the course’s theory. Use of terminology. |
1 | 4 | 8 | 12 | 15 |
Task #2 (15 points)
Use of the Template: The template is accurately used as provided and free of spelling errors. Content: Question fully answered, with relevant information and minimal repetitions. Theoretical Background: Gradual awareness of the course’s theory. Use of terminology. |
1 | 4 | 8 | 12 | 15 |
Task #3 (15 points)
Use of the Template: The template is accurately used as provided and free of spelling errors. Content: Question fully answered, with relevant information and minimal repetitions. Theoretical Background: Gradual awareness of the course’s theory. Use of terminology. |
1 | 4 | 8 | 12 | 15 |
Task #4 (15 points)
Use of the Template: The template is accurately used as provided and free of spelling errors. Content: Question fully answered, with relevant information and minimal repetitions. Theoretical Background: Gradual awareness of the course’s theory. Use of terminology. |
1 | 4 | 8 | 12 | 15 |
Task #5 (20 points)
Technical Documents 1: Communication in the Technical Workplace 2: Evaluating Readers 3: Working in Teams 4: Proposals 5: Activity Reports Sample 1 6: Activity Reports Sample 2 7: Instructions and Documentation Memo 8: Analytical Reports Logical Mapping 9: Analytical Reports Poster 10: Creating and Using Graphics |
1 | 5 | 10 | 15 | 20 |
Task #6 (20 points)
Introduction &Thesis Development Conclusion Unity Support Organization Sentence Skills |
1 | 5 | 10 | 15 | 20 |
NOTES. |