The Technical Writing Process
Describe the three main steps of the technical writing process and how you would use these steps to create the manual mentioned in this scenario.
a) Prewriting – Is the process in which we gather the information to be used in the manual. In this step we must examine the purpose for which we are writing, determine the goal(s) that we want to accomplish, consider the type of audience that will be reading the manual, using all necessary resources we gather the data required to complete the manual and finally, we must determine how we want to convey our information, which is in this case in a manual.
b) Writing – The writing process involves taking all the information obtained in the prewriting process
…show more content…
We do this by 1) providing specific details, avoiding the use of vague, abstract words that could be interpreted in different ways, 2) answering the reporters questions, this is done by making sure the who, what, where, when, why and how are answered during the course of the document, and 3) use easily understood words, the rule of thumb is if the reader has to use a dictionary, your writing is not clear enough.
e) Conciseness – the purpose of this step is ensure that the manual is brief and straight to the point, eliminating the use of drawn out words and sentences. This is done by 1) limiting the length of paragraphs, attempting to cram a lot of information in one paragraph hinders the readers ability to comprehend what was read, and 2) limiting the word and sentence length, the bigger the word the more likely it is that the reader will a dictionary to know what it means.
f) Accuracy – the purpose of this step is to validate the document by eliminating any grammatical and spelling errors. The most effective way of doing this is by proofreading your document. This step is a sure way to uncover mistakes made in the initial writing of the document. Some word processor applications have the ability to check your spelling and grammar. If all else fails, ask a friend to read your document to see if they can spot any errors.
g) Organization – the purpose of this step is to organize your thoughts in a way that allows the
Handbook is a useful resource which provides ways to effectively read texts. For example, analyzing can be used to break a book down into smaller parts to further help the reader. Evaluating, on the other hand, allows many things to be considered that will assist the reader in better understanding the text. Formulating is a method used at the end of reading which can help with the conclusion and provide details about the text. According to The Little
The chapter also goes into explaining the writing process itself in greater detail. Writers are encouraged to first make sure they fully understand their assignment, before then moving onto throwing around ideas (such as by brainstorming, clustering, ect), developing a thesis statement, and scheduling
Carolyn Isherwood, ID #21108433 Exam 05002400 1478 Angelus Hill Road, Hemet, CA 92545 isherwoo@fusion.gat.com Phoenix Advertising 112 South Front Street Charlotte, NC 12345-6789 January 31, 2011 Gregory S. Forest, President Phoenix Advertising 112 South Front Street Charlotte, NC 12345-6789 Dear Mr. Forest: Until the 4th quarter of 2010 the Roanoke branch had consistently ranked in the top 90th percentile with regards to productivity. They have received numerous coveted awards including “Most Innovated Advertiser”. Unfortunately there is evidence of some contention among the employees, which has resulted in a 20% decrease in productivity. In my capacity as Vice President of Human Resources, I have met with Kristina Jarrett, CEO of the
There are a few things we could have done better in this technical description. The decision to not include visuals was not a smart move. Visuals can help the audience understand the concepts we are describing easier. They can also allow the audience a different way to remember the material they have learned. The large sized text we had in the discussion somewhat function as visuals, but; we could have put more effort in this category by creating images to go along with each step in the process. I created the visuals for the instructions, which were very beneficial to the project.
Based on the Capella University writing process, the steps includes the student analyzing the audience to help determine the purpose of the paper. Therefore, the writing process does not differ because the same steps will still be use in creating the assignment. The important piece that will be different is the type of research and evidence used to support the main ideas within the paper. This information will provide support to the audience to ensure that the main purpose of the paper is clearly understood.
Prewriting- Explain to the students that the first step in the process approach to writing is prewriting which includes choosing a topic, planning and rehearsing.
Technical Reasoning: Technical Reasoning is not needed, because there isn’t anything specific that needs to be written briefly. Now it does say write five paragraphs 2 to 3 sentences long, but in my eyes thats not brief. In this pattern you aren’t using your hands to build anything.
Writing: Communicates thoughts, ideas, information, and messages in writing; records information completely and accurately; composes and creates documents such as letters, directions, manuals, reports, proposals, graphs, flow-charts; uses language, style, organization, and format appropriate to the subject matter, purpose, and audience; includes supporting documentation and attends to level of detail; and checks, edits, and revises for correct information, appropriate emphasis, form,
Inspection review: Inspection can help improve the quality of documents of the software product. Reviewer can find some defects before it goes into next step which reduce the reworking time and
What is the Writing process?The writing process is what you will need to go by when writing for essays and future classes.I have included a few tips throughout this template to help you get started. • You will need to identify the components of a basic sentence.• You will need to be able to identify the four most serious writing errors.• Define subject-verb agreement.• Identify common errors in subject-verb agreement.• Recognize regular and irregular verbs• Use regular and irregular verbs correctly in basic sentences.
3.Refer to the guidelines for writing an effective summary presented in the Module 2 lecture for use as a guide. Review the assignment rubric as well prior to beginning the assignment.
For this document to be of technical excellence, it must first have the eight measures of technical writing. One of the measures is honesty and this is important because the document should not mislead the audience. Three measures that go along together is clarity, comprehension, and conciseness because a document should be easy to understand
You want to make sure you have an introduction,body, and then a conclusion. Using Rhetorical strategies will help you tremendously when writing the paper. The rhetorical strategies are narration, description, examples, process analysis, comparison and/or contrast, classification, cause and/or effect, and definition. Narration is telling a story and making sure that story grabs the reader's attention. Description is using your word choice to paint a mental picture for the reader. Examples are when the writer uses specific to make a point. Process analysis is when the writer explains how something is done. Comparison and/or contrast shows similarities and differences. Classification breaks things down into different parts. Cause and/or effect explores the reasons why something happened. Definition explains what something
A ____ involves developing a clear, concise, and unambiguous statement of the exact problem the software is to solve.
When you hear the word “process,” what comes to mind? I immediately envision an assembly line. On the assembly line are people following the same steps over and over again to produce a final product. When writing, we do the same thing; however, we do it in a less stringent manner. We start with research and then follow the steps of the assembly line until we produce a final product, a written paper. Throughout this examination, I will discuss three of many steps in my research process for last weeks written assignment.