Get Started
Message from your Instructor
This message confirms that you have signed up for
Fundamentals of Technical Writing, a Fundamentals course that I will be teaching entirely online. I have prepared this document to help make your online educational experience as positive and enjoyable as possible. It contains contact information, a description of our course delivery system, course mechanics, and a course schedule.
How to get Started:
This course is conducted through an online classroom. You will need to go to this classroom to obtain your lessons, work through tutorials, take quizzes, complete assignments, participate in discussions with your fellow students, and ask questions of your instructor. As soon as the registration office verifies receipt of your payment, you will be able to participate. Here's how it works:
- Wait until after 12:00 a.m. (Pacific Time) on the start date for this course.
- After the course begins, go to
https://www.ed2go.com/utace/. The Online Classroom is open 24 hours a day and seven days a week, so please feel free to log in to your classroom at any time of day that is convenient for you.
- Once on the website, click the Login link at the top right of the page.
- Finally, log in with the username and password you provided us at the beginning of this orientation procedure. You should then be able to enter the online classroom and begin your studies.
Course Description
Do you have a knack for explaining complex subjects in a way that makes them easy to understand? If so, you should consider entering the well-paying field of technical writing. This course will teach you the skills you need to succeed as a technical writer. You will learn how to translate complex information into easily understood language, and how to become a wizard at marrying the art of publishing with the science of technology. You'll learn the secrets of successful technical writers, including technical writing conventions, interviewing skills, desktop publishing and formatting techniques, key tips for developing graphics and templates, documentation management, and how to publish documents both on paper and electronically. You'll also learn how to get your first job as a technical writer, plus tricks of the trade that enable you to create high-quality documentation with less work.
Course Requirements
Any version of Microsoft Word is acceptable. This course is not suitable for Macintosh users.
Course Mechanics
I will make two lessons available to you every week for six weeks. You do not have to be present when a lesson is released, but you'll need to complete each lesson within two weeks of its release.
Once all 12 lessons have been released, I will give you a two-week grace period to complete your studies and take the final exam. This means that you have a total of eight weeks to complete this course. If you're thinking of taking another course after this one, you can avoid overlap by starting that course exactly two months after this one begins.
Lessons are released by 12:00am (Pacific Time) on Wednesdays and Fridays. To access your lessons, simply visit the online classroom (as described in the "Getting Started" section), and then click the lesson title you wish to visit.
Once the class access ends, I won't be able to send you the lessons. If you would like to keep the lessons for future reference, I suggest using the print lesson feature in the classroom.
Each time you complete a lesson, you will also be asked to complete a brief multiple-choice quiz. I expect you to complete each quiz within two weeks from the date that the corresponding lesson was made available. I realize that you are busy, and don't want you to worry if you can't complete a few of the quizzes on time due to illness, vacation, or other commitments. Once I release a lesson and quiz, I will make sure it is available to you as long as the classroom is open.
The interactive multiple-choice quizzes are designed to test your comprehension of the course material. When you complete a quiz, you will receive an instant analysis of your work.
This analysis will include a brief explanation of any errors you may have made. If you are not satisfied with your performance, you are welcome to re-take the quiz until you feel that you have mastered the quiz objectives.
Note: If you ever want to see a progress report showing your performance on the quizzes over time, simply return to
https://www.ed2go.com/utace/
and click Login or Account at the top right of the page. Once logged in, click the Report tab under the course title.
Some of your lessons will also be accompanied by an assignment. The assignments are designed to help you expand your understanding of the material taught in this course. Assignments are typically more detailed and may take a bit more time to work through than quizzes.
I expect you to complete each assignment within two weeks from the date that the corresponding lesson was made available. Unlike the quizzes, your assignments will not be evaluated. Assignments are designed primarily for your enrichment. You have the sole responsibility for evaluating your performance on each assignment. If you have questions about an assignment, please feel free to use the Discussion Areas to discuss your assignments with your fellow students and me.
When you work through an assignment, you will be gaining practical first-hand experience with the new skills taught in this course. Your performance on the final exam will depend in no small part on your mastery of the assignments.
The course will conclude with a final exam, which will test your comprehension of the material covered in this class. You must complete the final exam within two weeks from your receipt of lesson 12. Please review your selections before submitting. You may only submit your final exam answers once. Your performance on the final exam is the only factor we will consider when determining your eligibility for a certificate of completion. Although your quiz and assignments will not count toward your eligibility for a certificate, I do recommend that you try to complete each quiz and assignment to the best of your abilities. Doing so will leave you better prepared to pass the final exam.
When you finish your studies, please note that our classroom log-out process is fully automated. We will log you out of the classroom automatically whenever you close your browser or shut down your computer.
Questions
This course can be highly interactive, but the level of that interactivity is controlled by you. Since I can't see that puzzled look on your face, it's going to be up to you to ask questions when you get stuck.
I expect to get many interesting questions from you and your fellow students. I want to make sure that you and your classmates benefit from these often illuminating queries.
Therefore, I would like to request that you avoid e-mailing your questions to me. Instead, I have created 12 Discussion Areas in the online classroom (one Discussion Area for each lesson). To reach these Discussion Areas, all you will need to do is wait for the course to begin, go to the online classroom, select the lesson you're working on, and click the Discussion Area tile.
Your Discussion Area questions will serve as a challenge for your fellow students. Someone is bound to have an answer for you. Likewise, you should be able to find questions in the Discussion Area that you can answer. The Discussion Area will be open to you and your classmates 24 hours a day and seven days a week. Please try to visit the Discussion Area at least every other day while the course is in session, and don't be afraid to participate!
I firmly believe that the best way to learn a new skill is to teach it to others. We will all benefit by helping one another understand this complex material.
Because I don't want to see any unanswered questions, I (or one of my very capable teaching assistants) will be monitoring the Discussion Area at least every other day (excluding weekends and holidays). If you ask a relevant question, but fail to get a correct answer (or any answer whatsoever) from your classmates, then we will try our hardest to answer the question for you.
Please understand that the Discussion Area is reserved for conversations about the material in your lessons. While it is perfectly acceptable for you to employ a bit of friendly banter as you converse with your fellow students and instructors, I must ask you to always remember to stay on topic.
It is not appropriate to use the Discussion Area to sell goods or services, complain about something, or talk about subjects that are not specific to the lesson at hand, for example. Such off-topic conversations waste people's time and detract from the learning experience for all involved. I reserve the right to immediately delete any message without comment if I feel that it does not pertain directly to the material I am trying to teach.
I will also delete any messages containing language that I feel is derogatory, controversial, insulting, or otherwise inappropriate for my classroom.
Reminder
A legitimate organization would never send you an unsolicited e-mail that contains an attachment or asks for personal information. If you ever receive an unsolicited e-mail that contains an attachment or asks for personal information, delete the e-mail immediately.
When to Write my Course Administrator
As I mentioned earlier, the course Discussion Area is reserved solely for discussion of the material in your lessons.
Please do not use the course Discussion Areas for compliments, complaints, technical support, or other personal matters. Instead, please send such messages directly to my course administrator.
To contact the course administrator, scroll to the very bottom of any page within the classroom and look for the Support link.
Please understand that it may take my course administrator two or sometimes three business days to respond to e-mail, so provide plenty of time for a response.
If you need an extension, forgot your password, want a progress report, want to register for another course, or need help when you're not in my classroom, you can contact Student Support using the Help link under Resources in the footer of any page at
https://www.ed2go.com/utace/.
Syllabus
Note: This course will run for six weeks. Two lessons will be released each week for the six-week duration of the course. You do not have to be present when each lesson is released. Instead, you can take up to two weeks to complete each lesson after it is released.
Important: In order to keep this material as up-to-date and informative as possible, I reserve the right to make changes to the course content, description, and syllabus at any time and without warning.
A new session of each course we offer starts on the second or third Wednesday of every month. You may enroll in more than one course at a time. If you are enrolling in a series of two or more courses, please be sure to space the start date for each course at least two months apart.
Week 1
Technical Writing Overview
Wednesday
Technical writing is a relatively new profession, but people have been writing technical documents for centuries. In our first lesson, you'll learn the fascinating history of technical writing, plus how the instructor (and many others) became technical writers and how technical writing employs both the logical and creative sides of your brain.
Preparing to Write
Friday
Technical writing requires preparation. In this lesson, you'll learn the basics of project management for your documentation project (including average amounts of time you should dedicate to different writing activities), key questions to help you analyze your reading audience, and how to organize the information you gather.
Week 2
Gathering Information
Wednesday
In today's lesson, you'll learn powerful communication skills that will help you get the information you need. You'll find out how to develop your listening skills and use body language that keeps you alert and encourages the people you're interviewing to talk with you. You'll also learn how to ask questions that help you get the answers you need more efficiently, and how to apply principles of adult learning when you're analyzing the information you've gathered.
Writing Skills
Friday
Do you ever get writer's block? Most writers do! Today you'll learn how to shut off your internal editor and give yourself permission to write your first draft more quickly and easily. You'll learn tips that will help you keep writing even when you realize you don't have all of the information you need, plus you'll have more confidence after you finish the grammar and punctuation review in this lesson, which includes tips about how to make your writing more interesting.
Week 3
Tech Writing Conventions
Wednesday
Every profession has rules and conventions that separate the novices from the pros. In this lesson, you'll learn all about time-honored technical writing conventions, such as using parallel structure, an inverted pyramid style of writing, effective headings, and lists.
Graphics
Friday
Should you save your graphics as bitmaps, gifs, or jpgs? In this lesson, we'll go over the difference between the most popular graphics file formats and guidelines for using each. You'll also learn about a new file format called PNG, and how to create screenshots on your PC, then manipulate your shots in Windows' Paint, saving you the expense of far more costly graphics programs.
Week 4
Document Formatting
Wednesday
Formatting your document can be critical to its success. In this lesson, you'll learn how to choose the typeface or typefaces you want to use and principles for using type effectively in your document. You'll learn about the things you need to keep in mind when laying out your pages. We'll take a look at some layouts that are commonly used in technical documents, then we'll discuss how to achieve those layouts using Microsoft Word.
Microsoft Word's Paragraph Styles
Friday
Microsoft Word has nearly a 93-percent market share for PC-based word processing—it's the de facto standard for most corporations and government agencies. So chances are high that you'll use it at some time in your technical writing career. In fact, most companies require that you be proficient with Word when considering you for technical writing positions. So in this lesson, you'll learn how Microsoft Word is different from other word-processing applications and how to use, modify, and create Word's paragraph styles.
Week 5
Document Templates
Wednesday
When companies use Microsoft Word for their documentation, they expect you to know how to use and create Word templates. In this lesson, you'll learn quick ways to build templates, plus you'll learn some Word skills that will help you dazzle potential employers, such as recording macros, customizing your toolbar, and using cross-references, AutoText, and captions.
Creating Indexes
Friday
Did you know that indexes are the most widely read section in any technical document? In today's lesson, we'll review indexing conventions, and I'll provide a few tips on building a great index for your document. You'll also learn how to use Microsoft Word to make indexing a bit easier.
Week 6
Editing and Proofreading
Wednesday
To polish your document and make it the best it can be, you need to proofread it and edit it. In today's lesson, you'll learn tips from professional proofreaders and editors, as well as ways you can use Microsoft Word to help you check your spelling and grammar.
Publishing Your Document
Friday
Publishing your document is an exciting time. All of your hard work is almost done—or is it? In our final lesson, you'll learn about different printing options and how to work with printers. You'll also learn about future trends in publishing and how your documents may be distributed in the future. Last, we'll talk about different ways you can use your technical writing skills in the job market, and a four-step plan for getting your first job, as well as some ideas about freelancing. Questions are always encouraged!
Instructor
With more than 20 years of experience as a senior technical writer, Janet Underwood develops technical documentation for major corporations in the computer, information technology, telecommunications, financial, and medical industries, as well as for U.S. government agencies and public utilities organizations. She started her career as an English teacher and later worked as an editor and writer for several internationally known trade publications before combining her love of technology with her passion for writing to become a technical writer. She has won numerous awards for the excellence of her writing and documentation design. Two of her books are used in technical writing classes in U.S. and Canadian colleges, and she teaches FrameMaker classes as an adjunct professor.