Free Essay

Tech Writing

In:

Submitted By kenny0472
Words 579
Pages 3
According to the Mayfield Handbook of Technical and Scientific Writing (2001), there are five characteristics that define effective technical communication; accuracy, clarity, conciseness, coherence, and appropriateness. For material that emphasizes clarity and conciseness, I find that section 1.1 of the Mayfield Handbook website falls short of delivering the material in such manners. These five characteristics will be used to provide an evaluative summation of the material. Accuracy in technical writing is comprised of three components; document accuracy, stylistic accuracy, and technical accuracy. Document accuracy refers to “proper coverage of your topics in appropriate detail” (Perelman, Barrett, & Paradis, 2001, p. section 1.1.1.). There must be a clearly defined problem statement, which is addressed with relevant data. Next, there is stylistic accuracy, which concerns appropriate use of language. This refers to the use of proper paragraph and sentence structure, as well as word choice that is effective in describing the topics. Finally, there is technical accuracy, which is shaped by the writer’s knowledge of the subject and the ability to analyze data without distorting the facts. The Mayfield Handbook does have proper document accuracy. The subject matter is relevant to technical writing. Stylistic accuracy is where the material is lacking. There is poor sentence structure and wording throughout the material. Simple proofreading would have caught the numerous conjoined words that are in need of a space to separate them. The Mayfield Handbook is up to par with technical accuracy, as the facts are presented with appropriate terms. The next characteristic of effective technical communication is clarity, which is the “ease of understanding” (Perelman, Barrett, & Paradis, 2001, p. section 1.1.2). Structural clarity is helped by using visualization items that help keep the subject in focus, such as; tables of contents, problem statements, strategic repetition, graphs and tables, descriptive titles, and frequent subject headings. Stylistic clarity is met by using direct language. This means using directly worded sentences as much as possible. Contextual clarity means the purpose of the writing is made clear to the reader through introductions, problem statements, citations, and other references. The third characteristic of effective technical communication is conciseness. This means to only include what is relevant to the task at hand. Conciseness is achieved by focusing the document scope. The Mayfield Handbook suggests preparing a clear introduction, detailed outline, and graphics to aid to the conciseness. Thorough revision is also a must. The next characteristic is coherence, which is “the quality of hanging together, of providing the reader an easily followed path” (Perelman, Barrett, & Paradis, 2001, p. section 1.1.4). This is done with style consistency, as well as organizational patterns of ideas. The Mayfield Handbook suggests using abstracts, clear titles, introductions, and problem statements to promote coherence in writing. Paragraph organization is also crucial to coherence. Organize paragraphs with a topic sentence, followed by supporting sentences. The fifth characteristic of effective technical writing is appropriateness. The writing should be appropriate to the goals, as well as to the audience. The target audience is what largely determines the appropriateness of material. The content of the Mayfield Handbook is appropriate for the target audience, and it succeeds in holding valuable information on the topic. The Mayfield Handbook has quite useful content, but it is poorly presented to the reader. Stylistic clarity lacks throughout the material due to the over-complicated wording of sentences. Coupled with the poor sentence structure, these faults make the material somewhat difficult to digest the first time through.

Similar Documents

Free Essay

Tech Writing Proposal

...SAMPLE TECH WRITING PROPOSAL INTRODUCTION AND DISCLAIMER This is an altered version of a real Tech Writing project submitted by a student and passed by an Evaluator. There is no guaranty that either the original version or this altered one would pass evaluation if submitted today. Despite our best efforts to provide consistent evaluation across all students and projects, Evaluators are human and are allowed latitude in grading. Additionally, your interpretation of what you see is likely to be different from the interpretations of others; in other words, even if you strictly follow the model of this paper, there is no guarantee of immediate success with your project. The original work was altered to mask the identity of its author and the various commercial products mentioned. References and their citations were also masked because no effort was made to determine whether other changes affected their validity. The inserted Comments indicate only that all required TaskStream sections are present, not that they are correctly completed for all types of projects. The best that can be said about the original work is that an evaluator found the work submitted to be sufficient to the task. Viewing this sample may or may not produce a similar result for you. Bottom line: You are the author of your work. We hope this sample helps to dissipate some of the uncertainty that surrounds the Capstone Project, but it cannot guaranty a trouble-free process. IMPORTANT: For maximum benefit...

Words: 7152 - Pages: 29

Free Essay

Math Tech Writing

...Gregory Furda Math 110 5/21/14 Technical Writing Assignment #2 In 1985, two friends, Dempsey and Tucker, started saving their money. The total amount of money in Dempsey's account is represented by the equation Ad(t)=7.53(1.041)t. The total amount of money in Tuckers account is represented by the equation At(t)= 10.42+ 0.53t. The purpose of this assignment is to use mathematical equations and calculations, as well as tables and graphs to compare the total amounts of money in each account and determine when the savings accounts will be equal and when one account will become larger than the other. The first step is to write out the equations as well as any other known data. The equation that represents Dempsey's account is Ad(t)=7.53(1.041)t. The equation that will represent Tucker's account will be At(t)=10.42+0.53t. The units of measurement for the money has been changed to "thousands of dollars" so the 7.53 will represent the original $7530 Dempsey had in his account and the 10.42 will represent the $10,420 that Tucker origninally had in his account. This will need to be changed to interpret the results correctly at the end. This account value will be called (A) and will be the dependent variable. The independent variable will be the time in years since 1985 and will be called (t). The growth factor for Dempseys account can be found within the parenthesis of the equation. This equation is exponential and represents an increasing...

Words: 472 - Pages: 2

Premium Essay

Tech Writing How-to

...North Carolina A&T State University Writing Center North Carolina A&T State University’s Writing Center’s purpose is to assist A&T undergraduates with: * Topic Development/Pre-Writing * Organization * Grammar and mechanics * ------------------------------------------------- Clarity, unity, and much more* ------------------------------------------------- ------------------------------------------------- Registration Instructions ------------------------------------------------- Before making an appointment, the student must be registered as a user in the University Writing Center’s (UWC’s) database. 1. ------------------------------------------------- To begin the registration process, go to www.ncat.mywconline.com 2. ------------------------------------------------- When on the home screen, select “Click here to register” and follow the instructions given. (YOU MUST USE A CAMPUS EMAIL ADDRESS TO REGISTER) 3. ------------------------------------------------- After completing the registration form, select the “register” option at the bottom of the above screen and you should be rerouted back to the login page with a successful registration message at the top of the login screen. ------------------------------------------------- 4. ------------------------------------------------- Use the login information you just created to login and select the term in which you require assistance. Then click “Log In”. -------------------------------------------------...

Words: 279 - Pages: 2

Premium Essay

Tech Writing - User Manual Critique

...User Manual Critique Munchkin Baby Gate User Manual Critique INTRODUCTION Almost any parent can attest to the importance of a good baby gate. The right gate can help keep your little one safe from many of the potential hazards around the house. In addition to protecting your child, a wall mounted baby gate is easier to use than a pressure mounted gate, typically looks better, and can be used safely at the top of a staircase. In order to reap the benefits of a wall mounted baby gate, it must be properly assembled, installed, and mounted. Most customers that buy a baby gate rely on the user manual included to help guide them through this assembly. Unfortunately, the majority of those that purchase the Munchkin Extended Baby Gate will find themselves very unsatisfied with the included user manual instructions. I know all too well how frustrating a poorly written user manual can be because I purchased the Munchkin Extended Baby Gate, and I had to suffer through the poor excuse of a manual provided. While the guide had some of the important pieces we expect from a solid user manual such as warranty information, hazard details, and equipment information; the manual does not however properly consider its audience. The manual also fails in its ease of use, and its document design. THE GOOD Ethical Instructions It is important for any successful user manual to be ethical. A key factor in doing this is to highlight the potential hazards and warnings involved in...

Words: 749 - Pages: 3

Premium Essay

Hrm in Israel

...The transition from a Socialist approach to a free market approach and the rise of a new high-tech sector are two remarkable shifts that have occurred in the last two decades in Israel. In the face of these changes, human resource (HR) practitioners are currently expected to assume new roles, adopt different work values, and apply appropriate strategies. HR managers in the low-tech industry still adhere to traditional values and strategies, including a reliance on trade unions and an emphasis on job security and the employees’ years of work experience and seniority as key criteria for promotion. In the emerging high-tech sector, HR managers have adopted new values and developed new strategies, including human resource management programs, employee empowerment, higher salaries and better benefits, while placing an emphasis on employees’ talents and qualifications. Source: http://www.emeraldinsight.com/journals.htm/journals.htm?issn=01437720&volume=22&issue=3&articleid=848302&show=html&PHPSESSID=qj5kp1babsuadbfaj 47luam41 Recent changes in Israeli society and economy and their relation to Organizational Politics Over the past three decades, Israel has undergone significant economic, industrial and cultural transformations. These developments have shifted public values considerably and may indirectly affect OP and HR practices. For example, Sagie and Weisberg (2001) maintain that in recent years, Israeli society has gone from being ascetic...

Words: 1651 - Pages: 7

Free Essay

Innovation

...CHINA BOOST FOR SENAI HI-TECH PARK Senai Hi-Tech Park, Malaysia's second high technology industrial park, got off to a promising start with investments of more than US$500 million (RM1.7 billion) from two companies in Johor. China-based EQ Solar Technology International Sdn Bhd plans to invest US$500 million to produce solar modules while leading industrial gases provider MOX-Linde Gases Sdn Bhd, through its initial outlay of RM60 million, plans to set up an industrial gases separation plant. Senai High Tech Park chief executive officer (CEO) Datuk Ahmad Shukri Tajudin said this shows that the park is ready to compete as another preferred location for hightechnology manufacturing, research and innovation activities. Located within Iskandar Malaysia, the park has drawn interest from investors in the US, Europe and China. "Interest is in various sectors including semiconductor industry and solar," he said at a media briefing. International Trade and Industry Minister Datuk Seri Mustapa Mohamed, witnessed the signing of the memorandum of understanding in Kuala Lumpur yesterday. "We're expecting a few more similar investments," Mustapa said, without disclosing details. Malaysia has so far attracted several global solar industry players like First Solar, Sunpower and Q-Cells. There are also several domestic investments in solar power projects in Selangor and Sabah. Mustapa hopes that the park will create more jobs, similar to what was achieved at the Kulim Hi-Tech Park in the north. The...

Words: 452 - Pages: 2

Free Essay

Guillermo Furniture

...over the years. Guillermo Furniture Store Recommendation Analysis and Recommend Financial Decision The economy is weak, new competitors’ establishing a presents, Guillermo must tackle a tough decision, which is to become a furniture distributor or stay on the manufacturing side, or possibility do both. Guillermo understands that change is forth coming and he has to venture forward but the dilemma is what the best alternative is. First Guillermo must analysis the financial alternatives and establish which objective is beneficial for the company. The next step is to gather information and formulate a pro forma cash flow budget to analyze the projected earnings for the next five years for the company (University of Phoenix, 2007). Hi-Tech Option Guillermo established his wealth various years ago because of the low cost in labor along with an extraordinary location for manufacturing. The company’s success has held strong on those foundations until now. There are a few concerns for Guillermo that may cause the company to change the way it does...

Words: 2497 - Pages: 10

Premium Essay

Four Strategically Required Organizational Outcomes for Siemens

...strategy-oriented HR system case study 1. * Strategically required organizational outcomes: * Good products and good services. Products and services is always the most important thing for a manufacturing company. Siemens has become a world leader by diversifying into hi-tech products and services, it need to maintain this advantage and develop it even further to achieve more. * Going global and expand. Globalization gives big companies a chance to expand rapidly. Siemens has succeeded in going global but this is a long way, it still needs more expansion into more countries or areas that are not covered yet. * Positive brand image. A good company image is extraordinarily important to the company’s healthy development. Siemens needs to keep customers satisfied both with its products and services, which helps it to get more market share and expand even faster. * A good employee selection, training and compensation system. The company not just need to keep customers satisfied, it has to keep employees happy too. So that it can work more efficiently and effectively. * Required workforce competencies and behaviors: * Learning on a continuing basis. Siemens is in high-tech business so the nature decided that its employees need to learn new things every day. * Good teamwork. The ability to work with people is essential in such big corporation. Especially when it’s going global. * Mutual respect and appreciation of workforce diversity. Siemens...

Words: 296 - Pages: 2

Free Essay

Mjlfdkjgl

...DARA & SON PVT. LTD Rohini, Sec. 29, New Delhi Research Paper by Manish Bhatt and Prabhudas Lilladher ATTRACTIVE MIDCAPS AMONGST RECENT IPO ISSUES:- [pic]Tech Mahindra and GMR Infrastructure have once again raised interest in the IPO segment. While Tech Mahindra and GMR Infra are obvious choices experts are also bullish on Nectar Life sciences, Unity Infra, All cargo Global and…With over subscription of Voltamp Transformer recently experts give attractive midcap picks from this fraternity for the long-term.   Future business model, sound managements, availability at prices below their issue price, attractive valuations, niche positioning within their industry and future growth are important reasons why investors should log on to these IPOs feel a bevy of experts Money control spoke with.   Apart from that Keynote Capitals in its report titled ‘Attractive Recently Listed Midcap Stocks’ have mentioned names like Nectar Life sciences, Repro India, Talbros Automotive and K Sera.   While a number of them are available at a substantial premium to their offer price, six of them are still quoting at a discount to their issue price.    Everest Kanto looks pretty good at current levels for the long term. All cargo Global also looks good in the recently listed midcap IPOs.   Both the companies are in a niche segment and have done quite well on the fundamentals post-listing. Everest Kanto ranks first as far as LPG cylinder manufacturing is concerned. It posted fairly...

Words: 1132 - Pages: 5

Free Essay

Managing in International Business

...NAME: Meghna Shrivastava STUDENT ID: c7080738 COURSE: B.A (HONS) International Business MODULE: Management of International Business MODULE TUTOR: Mr. Ashish Tripathi EXECUTIVE SUMMARY Club Mahindra holiday is a consumers service industry which is part of Mahindra group having infrastructure of US $ 14.4 million. Under Club Mahindra flagship Mahindra Holiday and Resorts India Ltd (MHRIL) was started in 1996 as a realty sector of Mahindra group brought up for bring values, reliabilities and trust and customer satisfaction. Club Mahindra has got an affiliation with RCI which consist of 60% of the service industry market share, which make Mahindra holiday timeshares largest holiday ownership brand in India. Apart from being a customer centric company club Mahindra performs various Corporate Social Responsibilities for the well fare of people, employees, its customers and environment. According to CESD, 2007 Tourism is becoming one of the largest business sector in the world showing 2005 receipt of international tourism reaching $6.82 trillion. Club Mahindra performs in service industry where revenue produced in 2008 by service industry was $4,028.6 billion showing CAGE OF 6.3% from 2004-08. (Datamonitor, 2009) Furthermore, club Mahindra perform or exist in environment where customers has the power to control the market. Whereas, large number of suppliers weakens them from leading, new entrants in service industry is very easy but the threat of substitutes and...

Words: 4784 - Pages: 20

Premium Essay

Born Global Firms

... Born Global firms often possess unique resources and capabilities such as entrepreneurial orientation of the founders, innovation behind products and technology, accumulated knowledge of the founders and managers from previous work experience, and networking capabilities. Managers with a previous background of international strong activity will give to the company a more sure address to its business expansion, for this reason a high level of entrepreneurial orientation supports the firm´s ability to recognize and create opportunities at an early stage. It can be argued that Born Global firms are typically found in niche business areas where products are unique, and require high amount of research and development like the high tech business area. It is very important to invest in products with a short life cycle and high technology sectors are characterized by this necessity of a continued innovation which can protect those firms and products from any imitation. As for geographic locations of these Born Global firms, their headquarters can be found in various countries, such as the United States, United Kingdom, Switzerland… Rich and large countries give birth to Born...

Words: 316 - Pages: 2

Free Essay

Micrologic

...Resource i.) R&D has 3 engineers ii.) Micrologic has 13 employees. iii.) Hilary De Leon hires people from only top 4 engineering schools. V. Social Responsibility Application i.) Encourage people to improve their lives. ii.) Give employment iii.) Payment of taxes to the government VI. Statement of the Problem How can Micrologic excel in Technological industry? VII. Statement of Objectives a. Long term To be the best in Research and Developing by having both Filipino and Foreign scientists and engineers. b. Short term To make sure that there would be a development In their support facilities in a year. VIII. SWOT Analysis A. Strengths i.) The company is known for their high-tech products with creative designs ii.) The company is both locally and internationally...

Words: 511 - Pages: 3

Premium Essay

Company Analysis- Mahindra & Mahindra Lid.

...Industry Analysis: 1. Industry trends: Indian and Global perspectives, recent happenings Mahindra & Mahindra Ltd. is the flagship company of the Mahindra group presence in the Aerospace, Agribusiness, Automobile, Components, Defense, Energy, Farm Equipment and Logistics industries. Let take a look at the industry trends in its main line of business Automotive and Farm Equipment. Automotive Industry: The Society of Indian Automobile Manufacturers (SIAM) plans to propel the Indian Auto industry to a global $145 bn industry by 2016 whilst promoting sustainability by addressing the multiple challenges arising out of emissions, climate change, energy security and safety. It plans to achieve its target by increasing competitiveness between the local rivals and put in efforts to bring in more eco-friendly products. The automotive industry has a highly cyclic demand and looking at the current global and national economic scenario it is in for some tough times. Also with high inflation and increasing presence of global heavy weights in the local market, the Indian Automotive Industry is in for its biggest test till date. Also attention must be focused on using technology to built more fuel efficient cars, hybrid cars, cars with lower CO 2 emission. Companies will need to maintain a balance with their investments in technology and profits in order to have a sustainable growth and also look to expand to global markets. On the global scale the...

Words: 497 - Pages: 2

Premium Essay

The Art of High-Technology Management

...The paper is mainly about the management of the high-tech companies in a successful way. The article is written as the result of a research that exceeds two decades which consists of surveys and interviews with several CEOs and executives from different high-tech industries and different-sized firms. In the article the authors define six key headings for a successful management of high-tech companies. After explaining all, they also put these topics in two groups which are paradoxical. The themes mentioned in the article which are “business focus”, “organizational cohesion” and “sense of integrity” represent the static and stable side of the paradox. On the other hand “adaptability”, “entrepreneurial culture” and “hands-on top management” are dynamic and changing side of the paradox. Six themes of the successful high-tech management that are mentioned in the article: Business Focus: To succeed as a technology firm, companies should focus their attention on production lines, R&D stage and business priorities. Instead of making effort for irrelevant and wide product portfolio, they should concentrate on well-known and well-done products, areas or trying to create new product lines or business opportunities which are related to these. For the technological leadership of the companies, R&D expenses also should be enduring in a few areas instead of being in many areas and discontinuous. Adaptability: A high technology company should be able to adapt and lead the rapid changes...

Words: 413 - Pages: 2

Premium Essay

Smartix Evaluation

...Smartix Case HBS Smartix 1. Imagine that you are Vivek Khuller. Should you accept the offer from MSG? I don’t believe that I would take the offer from MSG. Here’s the problem with not taking the deal: Accel is relying on the MSG deal far greater than anticipated, and the deal with Accel has a high probability of falling through once it is discovered MSG may not be participating in the way Accel is anticipating. The other issue at hand is that without the Accel deal, Smartix is nearly out of time and the funds required to continue aggressively pursuing the project. An alternative for Smartix in this situation is to scale it back and seek out a slightly smaller deal. They have the capacity to do so and it seems that they were aiming rather ambitiously with MSG. If they wanted to reassess their end game and dial it down some, they have the opportunity to connect with a slightly smaller venue or company and they have a short amount of time to do so. Another alternative to accepting the MSG deal is for the founders to gain outside employment in an effort to sustain themselves while they regroup Smartix to succeed under their terms. They all know that the last thing they want to do after all their hard work is become MSG employees. In the end, don’t accept a subpar deal if you know your venture is worth more. 2. Should Vivek have tried to start this venture without co-founders? Could he have been a solo founder? While not doubting his competence or his ability to...

Words: 781 - Pages: 4