Technical writing is used in many different ways to help an individual solve a problem. Different forms of technical writing include proposals, manuals, web pages, lab reports and many other professional documents. Technical comes from the Greek word techne, which means skill.
First, establish what kind of documents you plan to create. Some examples include: product descriptions, installation guides, configuration guides, maintenance procedures, online help, error messages, notifications, tooltips. When you are writing tooltips, notifications, or error messages, be clear, concise, and grammatically correct, keeping the format consistent. Finally, decide whether the document will be provided on paper, CD or integrated with the software.
While writing your document, make a list of glossary terms. Research these terms to create your definitions. When your draft is complete, use the spell check and review your work from cover to cover. Send your document to a subject matter expert to review the accuracy of your work. Once your document is in its final stages, ask a friend who has limited knowledge of the subject to review it, ensuring that it is understandable to the average person.
"The Technical Writing Process." Technical Writing Tips for Technical Writers and Managers of Writers. 04 Apr. 2009 http://www.docsymmetry.com/technical-writing-process.html.
"Technical Writing: What is It?" Dennis G. Jerz. 04 Apr. 2009 http://jerz.setonhill.edu/resources/FAQ/TW.htm.
Good post evan! I really liked the video you posted because it was very informative and apt. I thnk it is extremely important to take the steps that you suggested when preparing a technical writing in order to prevent confusion to the reader and to expedite the problem-solving process!
ReplyDeleteGreat job Evan !! other than extra image this post is realy nice done !! loved video and i think writing tecknically is really crusial in business world !
ReplyDeleteKeep up good work
The phrase "information that helps a reader solve a particular problem" is a direct quotation from my website, but here, there is no indication that Evan Grant did not write it himself. In fact, most of the words in the second sentence, and the entire third sentence were all lifted from my website.
ReplyDeleteThe only original thought I see in the opening paragraph is Grant's decision to drop "newsletters" from the list of technical documents I came up with.
I recently posted about a similar problem with the information Grant lifted from a different page on my website.
If this web page were an assignment submitted to my freshman composition class, I would give it a zero for plagiarism, and invite the author to my office to explain that simply listing sources at the end of a document does not give readers all the information that they need in order to judge the trustworthiness of a document.
Nice job, Evan. I just need you to inject a bit more of 'you' into your posts. More voice, man! Excellent concise video on technical writing.
ReplyDeleteEvan. I hope you see what Dennis has commented in regards to you post. This is pretty serious bro. I will check it out. I like your workcited at the end. perfect format. Thanks for the audio/visual. Post was a little too concise. Maybe use bullits for some of your ideas, next time. Good post. I have to question this Dennis character's motives. I'm a little awestruck due to the fact that it must have taken serious obsession and compulsiveness to find this blog and suddenly claim plagerism. Plus, I think it is a little unprofessional to accuse someone of plagerism in a comment post ona blog.
ReplyDeleteWell I apologize to Dennis for using his site as a reference as I have for a couple of my posts. I guess I wont refer to his site anymore. It has a lot of good information that I tried to re-word as best as possible. How did he even find this?
ReplyDelete