... Technical Writing Fundamentals Copyright Copyright © 2010, 2009, 2008 by University of Phoenix. All rights reserved. University of Phoenix® is a registered trademark of Apollo Group, Inc. in the United States and/or other countries. Microsoft®, Windows®, and Windows NT® are registered trademarks of Microsoft Corporation in the United States and/or other countries. All other company and product names are trademarks or registered trademarks of their respective companies. Use of these marks is not intended to imply endorsement, sponsorship, or affiliation. Edited in accordance with University of Phoenix® editorial standards and practices. Course Description This course covers the fundamentals and best practices of using written communication in business and in the information technologies. Topics include strategies, techniques for producing emails, memos, reports, proposals, project specifications, and user manuals, as well as other technical documents. Course Topics & Objectives Week One: The Technical Writing Process • Identify how writing methods are used in the corporate environment. • Discuss collaboration in the modern enterprise. • Identify collaborative technologies. Week Two: Technical Writing in the Corporate Environment • Identify intellectual property issues in the corporate environment. • Discuss the role that audience plays in technical writing...
Words: 2349 - Pages: 10
...else, let me give you simple facts about my name. Based on my research, the name Allen means noble and fair while my last name de los Reyes means royal. So what are we waiting for? Let’s now play TEXT TWIST. Technical writing, a form of technical communication, is a style of writing used in fields as diverse as computer hardware and software, engineering, chemistry, the aerospace industry, robotics, finance, consumer electronics, and biotechnology. [ Technical writers begin by forming a clear understanding of the purpose of the document they will create. If payment for production comes from a second party, this includes a detailed interview with the party that pays for the document's production. Technical writers then typically go on to gather information from existing documentation and from subject matter experts. A subject matter expert (SME) is any expert on the topic that the writer is working on. Technical writers are often not SMEs themselves (unless they are writing about creating good technical documentation). Workers at many levels, and in many different fields, have a role in producing technical communications. A good technical writer needs strong language and teaching skills and must understand the many conventions of modern technical communications. Technical writing teams or departments are often...
Words: 2194 - Pages: 9
...Scientific Communication:- Scientific:- Scientific means make use of the technique of science. “Scientific means technology or technical. It means connected to science or concern with science.” Communication:- Communication is usually common talk, chat or gossip. It’s concerning and linking populace or places. It means sender and receiver are exchange their ideas, views, belief and feelings. “While one person talking with another person or people and transfer a message to other person or people is called communication.” Its two way process of getting mutual understanding, where sender send their ideas, views, opinion and the receiver receive message and understand. Scientific Communication:- Definition;- “Scientific communication is section of science where communicate technical, engineering or other technological information.” Scientific communication is conversation about technical area such as computer appliance, medicinal procedures, and ecological convention. Its also conversation about technology by us of WebPages, help files or social media etc... Scientific communicators may put information they confine into paper documents, computer based training, web-pages, digitally stored text, videos, audios and other media. There are different uses of scientific communication. In software illustration help users are successful in their own improving and help to how effortlessly products expand and grow in marketplace as well as decreasing...
Words: 823 - Pages: 4
...HOW TO WRITE A TECHNICAL REPORT by Alan Smithee A report submitted in partial fulfillment of the requirements for ME 000 Some Course Department of Mechanical Engineering Fictitious Institute of Technology 01 January 9999 ABSTRACT Mechanics of writing a technical report is explained in a pseudo report format. The purpose of this pseudo report is to explain the contents of a typical engineering report. It can also be used as a template for an actual engineering report. With some adaptation, the format can be extended to other type of technical writings as well. TABLE OF CONTENTS ABSTRACT ................................................................................................................................i LIST OF FIGURES AND TABLES ......................................................................................... iii LIST OF SYMBOLS .................................................................................................................iv ACKNOWLEDGEMENTS ........................................................................................................v INTRODUCTION ......................................................................................................................1 EXPERIMENTAL DETAILS.....................................................................................................1 RESULTS AND DISCUSSIONS................................................................................................2 SECTION DESCRIPTIONS...
Words: 3413 - Pages: 14
...Course Syllabus SCBSIT0810 Technical Writing Fundamentals: ENG 221 Course Start Date: 03/08/2011 Course End Date: 04/05/2011 Campus/Learning Center: Schaumburg Please print a copy of this syllabus for handy reference. Whenever there is a question about what assignments are due, please remember this syllabus is considered the ruling document. Copyright Copyright ©2009 by University of Phoenix. All rights reserved. University of Phoenix© is a registered trademark of Apollo Group, Inc. in the United States and/or other countries. Microsoft©, Windows©, and Windows NT© are registered trademarks of Microsoft Corporation in the United States and/or other countries. All other company and product names are trademarks or registered trademarks of their respective companies. Use of these marks is not intended to imply endorsement, sponsorship, or affiliation. Edited in accordance with University of Phoenix© editorial standards and practices. Facilitator Information Susan Smillie smillies@email.phoenix.edu (University of Phoenix) srsmillie@yahoo.com (Personal) 630-833-5758 (CST) Facilitator Availability I will be available in...
Words: 5620 - Pages: 23
...informational work (usually of writing, speech, television, or film) made with the specific intention of relaying information or recounting certain events in a widely presentable form. Written reports are documents which present focused, salient content to a specific audience. Reports are often used to display the result of an experiment, investigation, or inquiry. The audience may be public or private, an individual or the public in general. Reports are used in government, business, education, science, and other fields. Reports use features such as graphics, images, voice, or specialized vocabulary in order to persuade that specific audience to undertake an action. One of the most common formats for presenting reports is IMRAD: Introduction, Methods, Results and Discussion. This structure is standard for the genre because it mirrors the traditional publication of scientific research and summons the ethos and credibility of that discipline. Reports are not required to follow this pattern, and may use alternative patterns like the problem-solution format. Additional elements often used to persuade readers include: headings to indicate topics, to more complex formats including charts, tables, figures, pictures, tables of contents, abstracts,and nouns summaries, appendices, footnotes, hyperlinks, and references. Some examples of reports are: scientific reports, recommendation reports, white papers, annual reports, auditor's reports, workplace reports, censusreports, trip reports, progress...
Words: 947 - Pages: 4
...Define user documentation Written or other visual information about an application system, how it works, and how to use it. (17) . User documentation refers to the documentation for a product or service provided to the end users. The user documentation is designed to assist end users to use the product or service. This is often referred to as user assistance. The user documentation is a part of the overall product delivered to the customer. The sections of a user manual often include: * A cover page * A title page and copyright page * A preface, containing details of related documents and information on how to navigate the user guide * A contents page * A guide on how to use at least the main functions of the system * A troubleshooting section detailing possible errors or problems that may occur, along with how to fix them * A FAQ (Frequently Asked Questions) * Where to find further help, and contact details * A glossary and, for larger documents, an index realized the importance of documentation many years ago when I joined an organization to head its IT function. The previous IT head had left the organization a couple of months ago. The managing director called me over and voiced his expectation. He told me that all ground work had been done for ordering new set of servers and application packages and that I should act upon it soon. I promised to take a look at the situation and revert with plans. However, when I sat in my department...
Words: 2026 - Pages: 9
...A Guide to Report Writing September 2008 CONTENTS Page 1. 2 INTRODUCTION ..............................................................................................................................1 PREPARATION ................................................................................................................................2 2.1 2.2 2.3 2.4 3 INTRODUCTION .......................................................................................................................2 PURPOSE ..............................................................................................................................2 PLANNING ..............................................................................................................................2 RESEARCH ............................................................................................................................2 CONTENTS OF A REPORT ............................................................................................................3 3.1 3.2 3.3 3.4 3.5 3.6 3.7 3.8 3.9 3.10 INTRODUCTION .......................................................................................................................3 TITLE PAGE ...........................................................................................................................3 CONTENTS PAGE ...................................................................................................................3 THE SUMMARY ....
Words: 4543 - Pages: 19
...categoryId=-1 IF You Face Any Problem Then E Mail Us At JOHNMATE1122@GMAIL.COM Question week 1 Technical Communication at Work (graded) As you read Chapter 1, you will learn that communication skills are critical in the workplace and that technical writing is used in virtually every work environment. For this discussion, locate a technical document from your workplace or from home or the Internet, preferably one that might be found in your career field. Note that Figure 1-1 (page 4) provides a list of technical communication examples. Using the five goals and features of technical communication listed in the textbook (page 4), describe how the document addresses these characteristics. Then, discuss whether or not you feel the document is successful in its overall goal. Provide examples from the document to illustrate. If possible, share the document by posting a link or a PDF of the sample used. Audience Culture and Analysis (graded) As our text states, “one cardinal rule governs all on-the-job writing: Write for your reader, not for yourself” (page 41). This requires a solid audience analysis. As part of this analysis, you must also consider the audience's cultural background, particularly in light of today's global society. For this discussion 1. discuss some general reader characteristics and methods for analyzing the readers of various technical and workplace documents; and 2. describe additional considerations you need to make when dealing with a...
Words: 3667 - Pages: 15
...making. Report may be classified in different ways. Like on the basis of formalities, On the basis of function, On the basis of frequency of issue etc. The basic objective of the report is to know the salient features of writing report & how the formal reports are important in Business Communication. Business report has no single correct answer but several solutions, each with their own costs and benefits to an organization. Report may be targeted to readers inside or outside the organization. In formal reports we have three parts. Two is Preliminary parts & Report body & the other one is Supplementary parts. With introduction parts the reader can get the assignment main topic & also helps the reader’s follows & understands information. It is an important parts of a formal business report. Supplementary parts view the readers where he found the details of the topic. In formal report readers have the clear facts views. Accuracy of facts, precision, Brevity, Clarity etc are the characteristics of business report. Often reports are structured in a way that reflects the information finding process and the writing up of the findings that is, summary of the contents, introduction or background, methods, results, discussion, conclusion and/or recommendations. The inclusion of recommendations is one reason why reports are a common form of writing in industry, as the informed recommendations are useful for decision making. Business reports are also written for employees, to keep them...
Words: 3609 - Pages: 15
...Web-Based User Manuals Shawn Craig ENG221 November 2, 2011 Dr. Yvette Irizarry Web-Based User Manuals Web-based user manuals are becoming more popular as manufacturers find it more cost effective to put their products manuals on the Internet. Printed manuals will still be available with the products but only provide essential information. Web-based user manuals provide in-depth information and include better visuals of the product. Many of the web-based manuals also offer interactivity, allowing the consumer to understand the product better. According to (Gerson & Gerson, n.d.) the techniques used for developing an effective, interactive, and web-based user manual are similar to writing a paper manual. Audience recognition, development, conciseness, consistency, ease of use, and document design are part of the process. The differences interactive web-based manuals must include are better visuals, interactivity, and more information. Adding product pictures in place of drawings gives the manual an improved look. Adding clickable tabs and links helps the user navigate the manual more efficiently. Online user manuals can also provide the consumer with more information about the product than a paper manual. Many products are too small, and the packaging may not provide enough room for an effective user manual. By providing a user manual online, all important information can be addressed without the constraint of space. These differences add to...
Words: 331 - Pages: 2
...User Manual Critique: Marantz DVD Player DV4003 This critique is on the Marantz DVD Player DV4003 user manual. This manual was chosen at random from brand names with which I am unfamiliar so as to provide an unbiased critique on its printed material. The user manual for this particular product is very comprehensive. Although there are 54 pages total including the covers, the information is organized well and in a logical order. The chapters are marked on the edge of the page for easy location in the manual, and the language (of the several available) in which this particular manual is written is highlighted on the top. The manual starts with a page giving congratulations on the purchase as well as information on DVD copy protection, the operating environment, and warnings and cautions. It welcomes the user and provides some valuable information before any startup or installation is discussed. This is followed by two pages of safety instructions that conclude with regulatory information. All of the legalities are covered before the “user” part of the manual begins. Following all of the legally required information is the table of contents which is thorough and accurate. It is well organized with headings for the specific categorized chapters and subheadings or the indexed items in those categories. It is very simple to go through and see what is contained under each heading, and to find the needed steps by the layout. Helpful notes are marked with a very visible icon to grab...
Words: 676 - Pages: 3
...INDUSTRIAL TRAINING TECHNICAL REPORT FORMAT Nigerian students studying science based courses in their 300 & 400 level depending on their course of study are supposed to embark on industrial training for a period of 3 months to one(1) year and this carries about 3-6 units in their second semester credit load. After the industrial training (I.T) period each student is supposed to write a technical report of his or her I.T experience this bears 25% of the total siwes marks. ALLOTMENT OF MARKS AS APPROVED BY ITF Log book Record/ Presentation: 25 marks Technical Report: 25 marks Attitudinal Observation: 10 marks Employers Report: 25 marks Oral interview by department (I.T defence): 15 marks. This makes technical report a major issue in gaining good grades from siwes. In writing a technical report the following format should be used COVER PAGE : This should contain the students name, department, matriculation Number, period of attachment (dates should be quoted), your employers name and location. DEDICATION PAGE for example . I dedicate this report to the almighty God. ACkNOWLEDGEMENT eg I will like to acknowledge my parents for their immense support, my lecturers and all who have contributed to this point in the success of my accademic pursuit. TABLE OF CONTENTS this should contain the afore mentioned and four chapters. CHAPTER 1 : This should contain the introduction, brief history of the firm where training was carried out and organisational chart. CHAPTER 2 : This should...
Words: 296 - Pages: 2
...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
...UNIT TITLE Unit Number David Grainger 0618244 HND Events 22/09/2014 Summary [Summary (optional): if your report is 2000 words or more a summary section is advisable. The summary should provide a brief synopsis of the content of the report, focusing on the main conclusions and/or recommendations.] Acknowledgments [Acknowledgments (optional): In a business report these should be kept to a minimum. It should include information regarding assistance provided by any organization or individual.] Table of Contents [Table of Contents (mandatory): you should draft this before you start writing the report, to give you a framework, but revisit it afterwards to make sure it still reflects the content and the sequence you actually followed, and to add page numbers. Most reports will need the sections identified in this template, with a further breakdown of the major ones if they extend to more than a couple of pages each. At this stage an appropriate numbering system should be considered.] Introduction I am writing a report based on a high society race night event that will be held in a meeting with my fellow college colleagues, I will be the community liaison officer during this event and meeting. I will be investigating the opportunities to work with community partners or local tourists information services. This report is written to share information about our event and also to share information about how I am going to overcome and progress in this...
Words: 685 - Pages: 3
