Creating a help document
Overview
In this assignment, you will create a help document. When writing technical documentation, particularly for online documents, it is not unusual to see the documentation broken down into multiple short help topics instead of one long file. Help topics are short definitions or descriptive information for users. These help topics are brief and easily searchable, only focusing on one specific issue or subject to allow the reader to find the information they need more quickly. Depending on the circumstances, help topics can also be reused across different documents for the same organization, making it easier for technical writers to maintain multiple writing projects with consistent, up-to-date information.
Prompt
Imagine you are part of a team of technical writers who have been tasked with creating help topics for your company’s support website. Choose one subject from the following list to base your help topic on:
How to set up a wireless mouse on a desktop or laptop computer
How to sync a remote to a television
How to reset a wireless router
How to download an app onto a smartphone
How to use the timer function on a stove or microwave
While you will likely encounter technical documentation for all of these subjects on the internet, you must create your own help topic based on the subject you choose using your own words. Any copying and pasting from existing technical documents will be subject to SNHU’s plagiarism policy.
Specifically, you must address the following rubric criteria:
Introduction: Explain briefly what the issue or task is and the purpose of the help topic.
Task Completion Steps: Write clear, concise steps that explain how to resolve the issue or complete the task in a logical, easy-to-follow order.
Additional Support: Provide examples of methods of additional support which users could access for further assistance with the issue or task (for example, a fictional support phone line, email address, accessibility document, or contact form).
Rationale: Provide a summary explaining your approach to writing the steps for this help topic, focusing specifically on the elements of minimalism you incorporated into them.
Guidelines for Submission
Submit your assignment as a Word document. Your assignment should be no more than 400 words in length, and you must use at least one source from either the course resources or external research to support your claims. Sources should be cited according to APA style.