Technical Writing-task 1 (Example)

Document Preview:

Critique of User Manual Documentation Student name: Institutional affiliation: A. AC 1 200 Smart Wi-Fi Router with External Antennas (R6220) user manual B. Discussion of Process Document The technical process of the NetGear Device Manual contains Chapter 5 Control Access to the Internet with subsections Set Up Parental Control Allow or Block to your network and Use keywords to block Internet Sites chosen based on interest from an audience that may find them informative. The main audience in the discussion is parents with children school administration and business executive. The smart Wi-Fi router can be utilized by both private and public for accessing the internet through wireless access networks. The user manual is very resourceful and summarizes some key features in a simple language for the readers. Using diagrams and systematic guidelines the NetGear Device User Manual is very useful capturing information users may require. The information is systematic in the user manual for support conformity and compliance gives the audience an easy time to seek clarifications on the internet about the product. Furthermore the format of PDF is useful for some reasons: Availability of the information into different formats like word when converted The resources accessible over the internet at user’s convenience Saves on storage space for the users Quite convenient than other formats of user manuals such as book and hard copies The company quickly updates and informs users on the improvements software upgrades and new versions of the product B6: Improvements Improvements include links to YouTube tutorials and audiovisual format of the same information because different audiences have new preferences. As a result the company diversifies the way information passed to the users. References: AC1200 - Smart WiFi Router. (2016). NETGEAR. Retrieved 25 July 2016 from www.netgear.com (2016). Www2.gsu.edu. Retrieved 25 July 2016 from http://www2.gsu.edu/~wwwtwc/genres.htm [...]

Order Description:

MCT2 Task 1: Find a small technical process document (or pick up to 5 pages from a large one) to critique for this task. You will need to submit the entire process document as a separate item, and it needs to be one that you are unfamiliar with, so you can have a realistic view of how effective it is at helping you learn about the given technical information. Two deliverables A. Process Document: Choose a suitable IT process document, per the task instructions (one you are unfamiliar with). You will submit this document as your first deliverable. B. Discussion of Process Document: B1. Audience: Discuss in detail the document’s intended audience. You can’t just name the audience; you must discuss how you know the intended audience, and what the needs and expectations of that audience might be. B2. Genre Conventions: Discuss in detail the genre conventions (technical writing-specific conventions) that are used in this document. Name three or four genre conventions and discuss each one separately. Be sure and discuss the characteristics of each one and how they help make the document effective. B2a. Technical Writing Principles: Explain and justify what tech writing principles are used in this document and how they contribute to its effectiveness. List and justify each principle separately, and be sure and explain how they make the document more effective! B3. Document Design: Evaluate and discuss the effectiveness of the document’s design based on the three given points of structure, design elements, and illustrative components. You will need to thoroughly address each point, and explain how each contributes to the effectiveness of the document. B4. Design Elements: Discuss in detail specific design elements in the document that make it suitable for print. B5. Online Access: Analyze how effective the organization of the document is for online access. You will need to list them, and explain how the specific elements make the document accessible online. B6. Improvement: List improvements you would implement to improve this document’s effectiveness, and be sure and give explanation and justification for each. C. Don’t forget to cite sources throughout your critique, and include an APA formatted References list at the end. I would like to use the technical process in chapter 5 Control Access to the Internet, which is on page 49-55. Focus on these items: Chapter 5 Control Access to the Internet Set Up Parental Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Allow or Block Access to Your Network. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Manage Network Access Control Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Use Keywords to Block Internet Sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54