Lecture Note Technical Writing Basic Sample Essay example

Submitted By Xavier-Zapata
Words: 2014
Pages: 9
Open Document
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 BMIS 200 Syllabus
Abstract
This paper provides students in the BMIS 200 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 in a technical review.
This single paper (and the accompanying writing exercise) is not going to make you an expert technical writer. But by applying these concepts (and practicing them throughout your various classes along the path to reaching for your educational goals), you will be provided two-fold benefits. First, your research papers will be easier to write and you’ll receive better grades. Second, by the time you graduate, you will be proficient at producing a technical report. This factor alone will give you some job hunting competitive advantage as there are many college graduates out there who cannot effectively put pencil to paper.
General Concepts
The usual method for starting a technical paper is to review current documents in the topic area and then follows-up with the thoughts of the author of the paper. This would be considered the literature review; a summation of what all the “experts” have to say about your topic. If this paper was being submitted for publication, I would also follow that model as well. But, as this paper is being prepared specifically for a class, it was decided best that we keep it focused on your class requirements. This paper will provide you the foundation that, if followed applied to your writings in the BMIS program, will be easily accepted. However, more important, are the foundational writing skills that will carry your career forward. You will find that what many of you will think is just a given professor’s “quirks” are really just plain good report writing standards.
While there are many potential pitfalls in technical writing, we have found four basic challenges that will lead to your successful writing. These are: flow and format, writing in complete thoughts, proper use of white space, and readability. Work on and master these four and you will be well on your way.
Flow and Format
This is the most important of the four. In fact, over time, mastering flow and form will lead writers to satisfying the other three without much additional effort. Flow and format are critical elements to writing anything above a short answer response. This includes responding to essay questions in homework and exams as well as research papers.
Flow
This is a very basic concept. Everything you write must have three basic parts: Introduction, Body, and Conclusion. The beginning, the middle, and the end, or, as many have simplified it this way:
1. Tell them what you are going to tell them, then
2. Tell them what you want to tell them, and finally
3. Tell them
Show More

Related Documents: Lecture Note Technical Writing Basic Sample Essay example

Essay on Amino Acid and Page

a lightbulb (of course!) but you should feel free to think of other images that might be relate to the central theme of DNA and proteins. Write the four stem questions around the central icon. Make this a little bolder/graphical than the usual writing you'll do. Remember one for each quarter of the page. These questions are: How are DNA/RNA like a secret code? How do we make copies of the code? Into what and how is the code translated into a message? What do we do with the message? Due Thursday…

Words 2559 - Pages 11

Researcher: Cash Flow and Special Consideration Essay

selection (FINS 5513). Students should only undertake this course after have taken FINS 5513 or a similar investments course. An understanding of modern investments also requires a fair amount of analytical skill. For example, students should have basic mathematical ability in dealing with algebraic manipulation and some familiarity with calculus, statistics, and regression analysis. Lastly, the participants should be familiar with Excel. Successful portfolio management requires the development of…

Words 3476 - Pages 14

Essay on project management

14 17 Overview of learning resources and assessment 17 ASSESSMENT INFORMATION 5 Essential reading 18 Learning outcomes 5 Referencing requirements 18 Assessment summary 5 Librarian 18 Assessment 1: Case notes (20%) 6 Other resources that might help with university life 19 Overview 6 Details 6 Marking criteria and standards 7 Assessment 2: Case presentation (5%) 7 Details 7 Marking criteria and standards Assessment…

Words 6308 - Pages 26

DISS HANDBOOK 2014 15 Essay

opportunity to conduct independent research and the development of in-depth knowledge in your chosen area. It aims to enhance your intellectual ability and enable you to demonstrate a more rigorous standard of critical analysis, reflective learning and writing skills. Viewed overall, the module requires the application of academic knowledge and research skills to meet a clearly stated objective. 1.1 Learning Outcomes: On successful completion of this module you will be able to demonstrate your ability…

Words 7950 - Pages 32

Columbus Regional Syllabus

Hours Lecture | | | | |Prerequisites/Corequisites: |Demonstrated competency through appropriate assessment or earning a | | |grade of “C” or better in ENGL 025 Introduction to College Writing II,|…

Words 4277 - Pages 18

Essay on Information Technology Project Management Appendix Answers

Solutions to Accompany Information Technology Project Management, Sixth Edition ISBN-10: 0324786921 ISBN-13: 9780324786927 Course Technology MIS Series Companion Web Site: www.cengage.com/mis/schwalbe Kathy Schwalbe, Ph.D., PMP Table of Contents CHAPTER 1 CHAPTER 2 CHAPTER 3 CHAPTER 4 CHAPTER 5 CHAPTER 6 CHAPTER 7 CHAPTER 8 CHAPTER 9 CHAPTER 10 CHAPTER 11 CHAPTER 12 APPENDIX A APPENDIX B APPENDIX C List of solution files available and referenced in this document, in alphabetical order:…

Words 19470 - Pages 78

Barbie: Communication and Discussion Board Essay

use this syllabus Three main parts I. Basic Speech Communication Course Information II. Specific Information for this Course III. General Eastfield College Course Information How to help yourself… First, look for the information you want in the syllabus. If you can’t find the answer then ask a classmate for help. If you still can’t find the answer then ask your professor. Part I Basic Speech Communication Course Information Course…

Words 6023 - Pages 25

Essay on Information Technology Project Management,

Solutions to Accompany Information Technology Project Management, Third Edition ISBN 0-619-159847 Course Technology MIS Series Companion Web Site: www.course.com/mis/schwalbe Kathy Schwalbe, Ph.D., PMP Table of Contents CHAPTER 1 1 CHAPTER 2 3 CHAPTER 3 7 CHAPTER 4 9 CHAPTER 5 13 CHAPTER 6 18 CHAPTER 7 22 CHAPTER 8 27 CHAPTER 9 31 CHAPTER 10 35 CHAPTER 11 38 CHAPTER 12 41 APPENDIX A 44 APPENDIX B 49 APPENDIX C 51 List of solution…

Words 31200 - Pages 125

Fins 2624 - Portfolio Management Notes Essay

Cheryl Mew FINS2624 – Portfolio Management Semester 1, 2011 LECTURE 1 – BOND PRICING WHAT IS A BOND? A bond is a claim on some fixed future cash flows. A commonwealth government bond (CGB) is a bond which pays semi-annual coupons, in which the maturity date/ coupon payment date is on the 15th of every month. A zero coupon bond is a bond with no coupons. The important information of a bond: 1. 2. 3. 4. 5. 6. • 1. 2. Transaction date: T Settlement date:T+2 Coupon payment dates Maturity date…

Words 14447 - Pages 58

Project Report On Employee Performance

job performance and career prospects. Distinction Between Hard Skills & Soft Skills: A distinction needs to be maintained between soft skills and hard skills. While hard skills refer to technical and academic skills, soft skills refer to wide-ranging personal and interpersonal skills. Academic and technical skills can be more easily defined, observed and measured. However, the measurement of personal and interpersonal skills requires complex factors. Importance of Soft skills To handle interpersonal…

Words 20716 - Pages 83