Premium Essay

Technical Writing

In: Other Topics

Submitted By gk2311
Words 3230
Pages 13
Technical Writing and Writing a Technical Report

[pic]Understand the type of technical report you are writing.
Technical reports come in all shapes and sizes, but they all share the same goal of communicating information clearly. Deciding what type of document you need to write is an important first step as it influences your approach.
For example, the following demand different approaches.
Reporting Research Findings
These documents describe the work done to gather information in the laboratory or field. They can be simple recording or data or more thorough and include: the problem or issue examined, the method or equipment used, the data collected and the implications.
Simple Technical Information Report
This document explains a technical subject. It has no aim other than to make sure readers understand the topic clearly. For example, a technical report on a investing in the futures market would probably explain how the market evolved, how it works, the specialist terms used and so on. A simple technical report for information does not put forward a view on the merits of investing in the market or have recommendations.
Technical Specifications
Specifications typically consist of descriptions of the features, materials, uses and workings of new product. Good specifications concentrate on graphics, data and illustrations rather than written descriptions. Think of a patent application as a good example.
Technical Evaluation Reports
Evaluation reports, sometimes called feasibility reports, present technical information in a practical and logical way to decide whether something is possible. For example, a technical evaluation report into setting up an intranet site for a corporation would examine if this was possible, set out the steps needed and point out any problems. It does not recommend if the corporation should set up its own intranet site.
Technical...

Similar Documents

Free Essay

Technical Writing

...This article is a guide to careers in technical writing. If you are interested in technical writing, here is a guide to the profession, and it include six parts. First, you need to know if technical writing is for you. Saul Carliner think that write a novel is not the job. Although the finished product is something you wrote, there's a lot of collaboration. Contrary to what many assume, this job requires plenty of contact with technical professionals, from programmers and project managers to machine operators and medical technicians. If you're considering a job as a technical writer, and you always spend several hours reading and reviewing computer manuals and online help systems. You need to know no one in the outside world will ever see it. But the field has broadened to include a variety of job roles and responsibilities. Second, you need background. As a group, technical communicators come from varied backgrounds. The five most common academic backgrounds are English, technical communication, science or engineering, computer science and journalism. Third, you need to know specific programs. You should know Microsoft word, FrameMaker, and RoboHelp. Forth, you can move into other IT jobs. Technical communicators often move into jobs as programmers, systems analysts, information architects and project leaders. Others shift into sales or management roles. Fifth, you need to get experience. Budding technical communicators should seek out internships, volunteer work and......

Words: 264 - Pages: 2

Free Essay

Technical Writing

...STYLES IN TECHNICAL WRITING What is style in technical writing? Styles: the feature of one’s writing that show its individuality, separating it from the writing of another. Style result from the conscious and subconscious decisions each writer makes in matters like word choice, word order, sentence length, and active and passive voice. These decisions are different from the “right and wrong” matters of wrong grammar and mechanics. Instead, they comprise writers make in deciding how to transmit ideas to others. Different styles in technical writing: a.a. Writing in clear sentences: Guideline 1: Place the Main Point near the Beginning One way to satisfy this criterion for good style is to avoid excessive use of the passive voice. Another way is to avoid lengthy introduction phrases or clauses at the beginning of sentences. Guideline 2: Focus on One Main Clause in Each Sentences When you sting together too many clauses with “and” or “but,” you dilute the meaning of your text. However, an occasional compound or compound-complex sentences is acceptable, just for variety. Guideline 3: Vary Sentences Length but Seek an Average Length of 15-20 Words Of course, do not think your writing process by counting words while you write. Instead, analyze one of your previous reports to see how you fare. If your sentences are too long, make an effort to shorten them, such as by making two sentences out of one compound sentences connected by “and” or a “but.” a.b. Being......

Words: 1375 - Pages: 6

Free Essay

Technical Writing Report

...Technical The Basics of Technical Writing for Management Information Systems Professionals David J. Donahoo Associate Professor, Liberty University Lynchburg, Virginia Submitted in Accordance With Guidance in the CSIS 100 Syllabus Abstract This paper provides students in the CSIS 100 course with an introduction to technical writing—one of the critical success factors for their future employment and career advancement. In this paper, students will be exposed to Four basic skills that will improve your technical writing. These include: flow and format, writing in complete thoughts, proper use of white space, and readability. This paper provides various tips to help you be successful in your college research writing and your follow-on professional life. Table of Contents Abstract 3 Introduction 6 General Concepts 6 Flow and Format 7 Flow 7 Flow Tips and Pointers 7 TIP 1:  Body 8 TIP 2: Introduction 8 TIP 3: Conclusion 8 Format 9 Complete Thoughts 9 White Space 10 Readability 11 Conclusion 12 Sample References 13 Introduction No matter where you are at in your life-long educational or professional career you will benefit from honing your technical writing skills. Believe me when I say this; technical writing takes your normal writing skills in a different direction. Some of the things you received praise from in high school composition classes will draw scorn......

Words: 2011 - Pages: 9

Premium Essay

Technical Writing

...Technical Writing Project Cover Sheet Capstone Proposal Project Name: Collaborative Business Intelligence Implementation Student Name: Joseph Thomas Degree Program: BSIT Mentor Name: Jeff Davis Signature Block JOSEPH THOMAS Student’s Signature Joseph Thomas Mentor’s Signature Table of Contents Capstone Proposal Summary 1 Review of Other Work 1 Rationale and Systems Analysis 1 Goals and Objectives 2 Project Deliverables 2 Project Plan and Timelines 2 References 3 Appendix 1: Competency Matrix 4 Appendix 2: 5 Appendix 3: 6 Capstone Proposal Summary The ClientABC has outgrown their existing file server environment, and is looking for a content management system with analytical capabilities. They have provided us with detailed requirements, and we have recommended the implementation of a Microsoft® SharePoint portal leveraging Microsoft® SQL Server for a Business Intelligence solution. The portal will only be required to be accessible from within the organization and not externally. This platform will address the specific needs of each department by allowing users to upload and share department documents, such as polices. The IT department will work with other department managers to develop custom workflows based on their business processes needs. The Administration group will help define the analytical dashboard and reporting needs of the organization, with the......

Words: 1566 - Pages: 7

Free Essay

Technical Writing

...correct square to relay the message. A technical report (also: scientific report) is a document that describes the process, progress, or results of technical or scientific research or the state of a technical or scientific research problem. It might also include recommendations and conclusions of the research. Unlike other scientific literature, such as scientific journals and the proceedings of some academic conferences, technical reports rarely undergo comprehensive independent peer review before publication. They may be considered as grey literature. Where there is a review process, it is often limited to within the originating organization. Similarly, there are no formal publishing procedures for such reports, except where established locally. Description Technical reports are today a major source of scientific and technical information. They are prepared for internal or wider distribution by many organizations, most of which lack the extensive editing and printing facilities of commercial publishers. Technical reports are often prepared for sponsors of research projects. Another case where a technical report may be produced is when more information is produced for an academic paper than is acceptable or feasible to publish in a peer-reviewed publication; examples of this include in-depth experimental details, additional results, or the architecture of a computer model. Researchers may also publish work in early form as a technical report to establish novelty,......

Words: 1284 - Pages: 6

Free Essay

Technical Writing

...Medicare and Medicaid are both government-sponsored programs designed to help cover healthcare costs. While both were established by the U.S. government in 1965 and are taxpayer funded, they are actually very different programs with differing eligibility requirements and coverage. Medicare is designed to help with long-term care for the elderly, while Medicaid covers healthcare costs for the poor. Medicare is a federal program attached to Social Security. It is available to all U.S. citizens 65 years of age or older and it also covers people with certain disabilities. It is available regardless of income. Medicaid is a joint federal and state program that helps low-income individuals and families pay for the costs associated with medical and long-term custodial care. The federal government funds up to 50% of the cost of each state's Medicaid program, with more affluent states receiving less funding than less affluent states. Because of this federal/state partnership, there are actually 50 different Medicaid programs, one for each state. Unlike Medicare, which is available to everyone, Medicaid has strict eligibility requirements. Medicaid is often used to fund long-term care, which is not covered by Medicare or by most private health insurance policies. Medicaid is the nation's largest single source of long-term care funding. Medicare and Medicaid programs work together to provide medical coverage to elderly and poor people. Medicare is the primary medical coverage......

Words: 312 - Pages: 2

Free Essay

Technical Writing

...Dear Valued Customer, At CPAs Industries Incorporated, your satisfaction is our primary concern. Combining advanced engineering and marketing concepts with first- rate Filipino craftsmanship, we give you products that pass through rigid quality control tests to ensure their reliability and consistency of performance. The new lightweight touch screen calculator is the latest result of our continuing commitment to provide you with durable and energy- efficient device. Today’s modern world, a high tech way of calculating is necessary to save time and energy. For your convenience, we have established a nationwide network of strategically located maintenance and repair centers to service any CII product. Should you have a problem with your unit please see or call the CII franchise service centers nearest your home. Our service centers will be most happy to assist you. Truly Yours, MA. VELLE M. MARIANO Chairman and Chief Executive Officer PRODUCT DESCRIPTION Digi-E-Calc stands for “Digital Electronic Calculator”. It is a calculator with high-tech features and state-of-the-art design. Digi-E-Calc is a rectangular lightweight tablet which measures 5”x3.5”x0.5” with ultrasensitive touch screen and lithium and dry cell batteries which could last for two days (and can be recharged again just by connecting the power plug located at the side of the gadget in an outlet. Its two dry cell batteries can be used as a back-up power supply in case of a power drain of the......

Words: 2658 - Pages: 11

Free Essay

Technical Writing

...Professional Knowledge and Abilities Calvin Nicholson GEN/200 January 22, 2011 James Tagliamonte Professional Knowledge and Abilities The American Society for Training and Development was founded in 1944 and now boasts a membership of about 70,000 business professionals. As stated in the ASTD website, it is a leading association of workplace learning and performance professionals forming a world-class community of practice. Their website lists a wealth of resources they offer which includes exclusive research tools, publications, career support, discount on books, conferences and professional development workshops as well as endless opportunities to network with colleagues from around the world. It also enumerated the numerous certificate programs that can help provide the necessary knowledge, training and recognition needed by business professionals to perform on their jobs and succeed. One certification that would be very beneficial to obtain is the CPLP which stands for Certified Professional in Learning and Performance. Aside from providing valuable resources and learning materials, this association also provides the opportunity for networking among peers. The ASTD sponsors conferences and expos and online discussion forums. These conferences and expos have themes that are extremely important in today’s global network. Topics range from outsourcing to e-learning and use of technology. By being the voice of the profession, the ASTD also became a......

Words: 521 - Pages: 3

Free Essay

Technical Writing

...D-Wave Computer's Solution Raises More Questions Sophie Bushwick An experimental computer made by a Canadian company has proved its ability to solve increasingly complex mathematical problems. But the question remains — just how much of this calculating power is actually due to the strange properties of quantum mechanics? In theory, quantum computers can perform calculations far faster than their classical counterparts to solve incredibly complex problems. They do this by storing information in quantum bits, or qubits. At any given moment, each of a classical computer's bits can only be in an “on” or an “off” state. They exist inside conventional electronic circuits, which follow the 19th-century rules of classical physics. A qubit, on the other hand, can be created with an electron, or inside a superconducting loop. Obeying the counterintuitive logic of quantum mechanics, a qubit can act as if it’s “on” and “off” simultaneously. It can also become tightly linked to the state of its fellow qubits, a situation called entanglement. These are two of the unusual properties that enable quantum computers to test multiple solutions at the same time. But in practice, a physical quantum computer is incredibly difficult to run. Entanglement is delicate, and very easily disrupted by outside influences. Add more qubits to increase the device's calculating power, and it becomes more difficult to maintain entanglement. Instead of struggling to keep ever-larger numbers of......

Words: 1002 - Pages: 5

Free Essay

Technical Writing

...1. In the previous exercise, you found article related to millennials.  For this exercise, please either find the same article or conduct a new search and find a new article on the topic of millennials. When you have found the article, follow the instructions provided on the video and select a new database on the right-hand side of your screen.  Then answer the following questions: -What database did you select? ABI/INFORM Global -How many hits do you find? 3,385,038 When you have found an article, follow the instructions provided on the video and select a new database on the right-hand side of your screen.  Then answer the following questions: -What were your search terms? (Fast food OR restaurants OR eatery) AND (Obesity OR Overweight) AND (Children OR Adolescents) -What database did you select on the right-hand side?  Health Source: Nursing/Academic Edition Why did you select this database? I select this database because it mostly consist of health issues and clinical nutrition. -How many hits do you find after choosing this database?   48,245 Jobs — There’s a minimum wage, but should there also be a maximum wage/salary a person can earn? School — Exams often do little more than measure a person’s ability to take exams. Should exams be outlawed in favor of another form of assessment? Personal — should people with earing-aid be exposed to more noise around them? Topic: There’s a minimum wage, but should there also be a maximum......

Words: 343 - Pages: 2

Free Essay

Technical Report Writing

...THE UNIVERSITY OF THE WEST INDIES ST. AUGUSTINE, TRINIDAD AND TOBAGO, WEST INDIES FACULTY OF ENGINEERING & ENGINEERING STUDENTS’ SOCIETY Technical Report Writing Workshop Facilitated by: Halcyon Lawrence March 03, 2007 Table of Contents Topic 1: The Communication Model ............................................................................. 4 Topic 2: Five Cs of Technical Communication .............................................................. 7 Clarity ............................................................................................................................. 7 Structural Clarity (document level) ............................................................................ 7 Stylistic Clarity ........................................................................................................... 7 Grammatical Clarity.................................................................................................... 7 Contextual Clarity....................................................................................................... 7 Conciseness..................................................................................................................... 8 Document level Conciseness ...................................................................................... 8 Paragraph/sentence level Conciseness........................................................................ 8 Concreteness ......................................

Words: 11012 - Pages: 45

Premium Essay

Technical Writing Proposal

...INTERNET MINIATURE PINSCHER SERVICE (IMPS) DC METRO REGION LET'S SAVE MORE MINIATURE PINSCHERS Proposal to Update IMPS Maximum Intake Age William L. Harris Jr, IMPS Regional Coordinator DC, DE, MD, VA, WV 12/13/2014 Informative Abstract: This proposal is the result of research into the effects of the current Internet Miniature pinscher Service policy restricting the intake age limit of five for rescues. The current policy is in effect from a time in the past when money was tight and vet bills were high. The proposal highlights three possible courses of action including maintaining the status quo, changing the limit to seven years and replacing the age limit with a percentage based system to identify how many seniors can be taken in. The author identifies multiple ideas that can be used to bring the veterinary costs down while at the same time allowing more dogs to be rescued. Of the three Courses of Action, only one works today, which is the increase to seven, but there is a way forward highlighted that could eventually result in a removal of the age limit and conversion to a percentage based senior intake system. William L. Harris Regional Coordinator DC, DE, MD, VA, WV Internet Miniature Pinscher Service 1730 Underwood Rd Gambrills, MD 21054 13 December 2014 Petrea Hoving National Director Internet Miniature Pinscher Service 55 East 72nd St Apt 4N New York, NY 10021 Dear Petrea Hoving: Enclosed please find a proposal......

Words: 2721 - Pages: 11

Premium Essay

Technical Writing Manual

... | | | | Table of Content I. Introduction 1 A. Summary 1 B. Purpose 1 C. Glossary of Terms 1 II. Center for Writing Excellence 2 A. Introduction to the Center for Writing Excellence 2 B. WritePoint 2 C. Tutor Review 3 D. Plagiarism Check 3 E. How to submit a document for review 3 F. Writing Tools 4 1. Tutorials and Guides 4 2. Writing Manuals 5 3. Finding Help 5 III. Library Services 6 A. Introduction to Library Services 6 B. Search FAQ’s 7 C. Ask a Librarian 7 D. Request a Specific Document 8 E. View the Research Tutorial 9 F. Read the Library Guide 9 G. Library Resources 9 1. Article Databases – Major 10 2. Article Databases – Specialized 10 3. Books, Dissertations, and Theses 10 4. Canadian Indexes 10 5. Company Directories and Financials 10 6. Country Profiles and Economic Data 10 7. Encyclopedias and Dictionaries 10 8. Journal Indexes and Abstracts 11 9. Test Guides and Preparation 11 10. Writing and Publishing Resources 11 11. Choose Databases by Subject 11 12. Find a Specific Publication 11 13. Biblioteca in Español 11 14. Library Resources Location 11 IV. Center for Mathematics Excellence 13 A. Introduction to Center for Mathematics Excellence 13 B. Running Start 13 C. Math Anxiety 13 V. Element K Tutorial 14 A...

Words: 3529 - Pages: 15

Premium Essay

Technical Writing - Radon

...[pic] Homeowners Radon Alert [pic] All homeowners need to be aware of the very real risks of home radon exposure. This bulletin will tell you what you need to know about radon exposure and how to protect your home. What is radon and what are the dangers of radon exposure in a home? Radon is a colorless, odorless, tasteless gas that is created by the natural breakdown of uranium in the earth. The accumulation of radon in a home can present a very real health hazard. Prolonged inhalation of radon gas leads to an increased risk of developing lung cancer. How does radon get into a home? Radon is present in the soil and air in varying quantities almost everywhere in the world. Radon levels vary from home to home, depending on the structure of the house and the surrounding soil. The most common entry paths for radon are through small spaces, such as cracks in concrete, floor drains, sump pump openings, wall/floor joints in basements, and the pores in hollow brick walls. Radon generally concentrates most in the areas of a home closest to the ground and decreases in upper stories. Radon can also seep into underground water and remain trapped there. Homes where water is supplied through a ground water supply source, such as a well, have a greater potential for radon problems. Homes with water supplied by a municipal water supply have fewer problems with radon. How is radon detected in a home? Testing is the......

Words: 531 - Pages: 3

Premium Essay

Assignment 2 Technical Writing

...or FALSE by writing T or F in the blank. 1. _______ Most workplace documents are created by individuals working alone. 2. _______ Technical documents are almost always designed for expert readers. 3. _______ Effective communicators “let the data speak for themselves.” 4. _______ The more you advance in your profession the more your ability to communicate is likely to become essential. 5. _______ Direct, straightforward communication is valued by all cultures. 6. _______ Electronic communication is replacing paper documents in the workplace. Complete the following statement. 7. A computer can transmit data, but it cannot give ___________________ to the information. In items 8–10, choose the letter of the expression that best completes each statement. 8. _______ A technical document focuses on (a) the needs of the audience, (b) the writer’s feelings, (c) both the needs of the audience and the writer’s feelings, (d) marketing, or (e) none of these. 9. _______ An effective technical document is based on (a) intuition, (b) usable information, (c) the writer’s deepest impressions, (d) inspiration, or (e) none of these. 10. _______ The information in a technical document must be (a) entertaining, (b) accessible, (c) confidently judgmental, (d) prosaic, or (e) none of these. Chapter 2 Quiz Indicate whether statements 1–7 are TRUE or FALSE by writing T or F in the blank. 1. _______ Primary and secondary audiences read technical documents......

Words: 909 - Pages: 4