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

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

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

...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 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

...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

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

Premium Essay

Legal and Technical Report Writing and Presentation

...Technical paper Name Date Object oriented Program or rather OOP entails an object with data files which are organized in a manner that integrates procedures ad instructions that are incorporated into data fields. The system is essential in combining computer programs with a similar objective and point of operations. For example, computer operations have a similar language that is integrated in programming such as JavaScript, Smalltalk, and Python C ++. The difference is similar due to data and codes that are used to give attention to connected programs. The scope area focuses on how the way a company collects and aggregates data from disparate data sources. Additionally, the actual data collection in the organization ensures reliability and validity of actual collected. Innovative information data collection method simplifies data and aids data sharing among every department. Their scope of data management and analysis entails the second concept of data analysis. IT innovations have helped different organizations to access data from different departments. This means that OOP methodology is convenient is saving data and it is more secure when handling data from crucial projects. The object oriented programming therefore enables one to create objects and classes also that are prototypes or better imitate the real world unlike in the technical programming that puts more prominence on orders rather than the presentation. The main......

Words: 886 - Pages: 4

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

Premium Essay

Oral Presentation Technical Writing

...Oral Presentation Technical Writing Often, technical writers must present their materials—either to demonstrate their efficacy or to persuade a prospective customer (or superior) of the need and value of the materials they’ve prepared. A good oral presentation is clear, informative, entertaining, and memorable. The best way to give an effective oral presentation is to PREPARE it carefully. Even the most nervous of public speakers will be more confident if she has prepared the presentation carefully, practiced the presentation a number of times, and attempted to prevent or anticipate any possible glitches. Assignment: As part of your ongoing work on the website project (the website proposal and the website itself), you will prepare an oral presentation for Ms. Courtney Blair to show her your completed website and help her to understand its benefits to your company. Your report should be about 7 minutes in length and—for the most part—your visuals will consist of the website you’ve created. If you like, you may also prepare accompanying data (such as charts indicating how the website will enhance a company’s visibility or sales) and “toggle” between your website and the document camera (and you’ll all have the opportunity to practice using this before you give your presentation). You may use note cards if you like, but I’d prefer you not read—word for word—from a prepared script. A “memorized” speech lacks spontaneity and usually does not engage your audience. While......

Words: 411 - Pages: 2

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

Free Essay

Week 2 Technical Writing Survey

...Please submit your survey in the box at the chamber of commerce. We will post a copy of the results on our website at www.swelloilpros.com as well as the chamber of commerce receiving the results. Your Age:____ 20-29 ____30-39 ____40-49 _____50 or older Home status: ____Rent ____Own A pipeline runs across your property ____Yes ____No Have you noticed a reduction in pipeline emergencies in our town? ____Yes ____No Have you seen our product installed in your neighborhood or others? ___Yes ____No Does installation of poly liners in pipelines make you feel safer? ____Yes ____No Would you like to see these used to reduce pipeline failures more often? ___Yes ___No Any other feed back you may have would be greatly appreciated by writing it here. __________________________________________________________________________________________________________________________________________________________________________________________________________________________________________ ...

Words: 426 - Pages: 2

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

Premium Essay

Bsit Technical Writing / Capstone Wgu

...Technical Writing Project Cover Sheet Capstone Proposal Project Name: Network Infrastructure Upgrade Proposal Student Name: FRANK RIZZO Degree Program: BSIT Mentor Name: REJINA WIDENER Table of Contents Captone Proposal Summary 3 Review of Other Work 6 Rationale and Systems Analysis 8 Goals and Objectives 10 Project Deliverables 12 Project Plan and Timelines 14 References…………………………………………………………………………………………………………………………………………….17 Capstone Proposal Summary United Luxury Housing LLC. (Hereinafter referred to as “ULH” or “the company”) prides itself on being one of the fastest growing property management companies in the United States. ULH owns and or manages luxury apartment communities in eight states currently and is projected to double in size over the next three to five years. ULH takes pride in their unique luxury properties that include amenities such as 24 hour maintenance and pool access, top-of-the-line workout facilities, on-site stores with groceries and commonly used household goods, luxurious club houses, movie theaters, and free high-speed internet. ULH experienced most of its growth over the last 18 months and until now had not realized that their outdated network infrastructure could possibly inhibit future growth. ULH is seeking proposals to upgrade their IT infrastructure to be able to better meet existing demand and future growth. This proposal and project will consist of the following five......

Words: 3634 - Pages: 15

Premium Essay

Technical Writing Proposal

...vaccinations costs will come down. Currently we are vaccinating dogs on a yearly basis. If we change that to line up with more recent information on how long vaccines are good for and ensure that dogs are up to date on vaccines at intake, it would cost less overall to provide initial veterinarian care for an older dog (Richards, n.d.). Vaccinating younger dogs on an annual basis while they are still building up the antibodies will actually cost significantly more. Vaccination background info: There are three basic schools of thought on the length of time between vaccinations for dogs. First off would be the vets that think yearly shots are necessary. They quote four reasons to think this: 1) The vaccine manufacturers have said in writing to do that and following label directions lessens liability. 2) There isn't much published information in scientifically reviewed journals that refutes the once yearly vaccination schedule. 3) It is the way things have always been done and it can be proven there has been a large decrease in distemper, parvovirus, etc over the years, so why stop something that is working? The second school of thought is that vaccines should be extended to every three years. Some reasons for this are: 1) Some dogs react badly to vaccinations, at either the time they are given or several weeks later being diagnosed with immune mediated hemolytic anemia (IMHA). 2) There is not enough information to tell how long vaccines really last. It is......

Words: 2721 - Pages: 11

Free Essay

Web Development Technical Writing

...WESTERN GOVERNORS UNIVERSITY Submittal Cover Sheet Date: February 14, 2011 Student Name: Selina Coley Student ID Number: 182287 Student Degree Program: Information Technology – Software Emphasis Student Email: snolley@wgu.edu Four Digit Assessment/Project Code: TWA1 Mentor Name: Vinton Smith For Revisions Only Indicate Previous Grader: Submissions received with an altered, incomplete or missing cover sheet will be returned for resubmission. Submit to: Western Governors University Attn.: Assessment Delivery Department 4001 South 700 East, Suite 700 Salt Lake City, Utah 84107-2533 wgusubmittals@wgu.edu[->0] Technical Writing Project Cover Sheet Capstone Proposal Project Name: Static Website – www.booksandbottles.org Student Name: Selina Coley Degree Program: Information Technology – Software Emphasis Mentor Name: Vinton Smith Signature Block Student’s Signature Selina Coley Mentor’s Signature Table of Contents Capstone Proposal Summary 1 Review of Other Work 3 Rationale and Systems Analysis 4 Goals and Objectives 5 Project Deliverables 6 Project Plan and Timelines 7 References 9 Appendix 1: Competency Matrix 10 Capstone Proposal Summary My project proposal is to develop a static web site for a growing organization based in Sterling, Virginia. The mission of Books and Bottles is to promote healthy development of infants and young children through proper nutrition and early childhood exposure to......

Words: 2710 - Pages: 11

Registrieren | Abuelos Al Poder | Bernie The Dolphin