Copyright

Ch 5: Formatting Technical Documents

About This Chapter

Improve your understanding of how to format technical documents with lessons on ethical dilemmas in technical writing, mistakes of composing definitions, and more. Prepare for an exam, complete homework, or expand your professional skills by watching these entertaining lessons.

Formatting Technical Documents - Chapter Summary

Dive into this chapter on formatting technical documents with fun lessons on how to write technical descriptions and technical specifications. You'll also boost your understanding of front, body and end matter in technical documents. By the end of the chapter, you should be able to:

  • Discuss titles and headings in technical documents
  • Provide an overview of summaries and abstracts in technical documents
  • Explain how definitions are used in technical writing
  • Describe ethical issues in technical writing
  • Recount mistakes of composing definitions in technical writing
  • Give an example of an introduction for a technical document
  • Outline technical document conclusions
  • Craft a recommendation in a technical document

Professional instructors developed content for these entertaining lessons to help you fully understand how to format technical documents. Take a short self-assessment quiz to make sure you have grasped the concepts covered. Each video lesson includes a full written transcript that you can print and use to study offline.

12 Lessons in Chapter 5: Formatting Technical Documents
Test your knowledge with a 30-question chapter practice test
Titles & Headings in Technical Documents

1. Titles & Headings in Technical Documents

Titles and headings alert readers to the topics covered in a technical document. This video explains the purpose, design, and placement of titles and headings in technical writing.

Front Matter, Body & End Matter in Technical Documents

2. Front Matter, Body & End Matter in Technical Documents

In a technical document, it is sometimes necessary to include information at the beginning and end to help organize and explain the content. This video explains the types of material included in the front matter, body and end matter of a document.

Summaries & Abstracts in Technical Documents

3. Summaries & Abstracts in Technical Documents

People want to know whether a document is relevant to their business without having to read the entire document. This video explains the different types of summaries and abstracts and how to write them.

What Are Definitions in Technical Writing?

4. What Are Definitions in Technical Writing?

Including definitions in technical documents is a common requirement for reader comprehension. This video explains why definitions are needed, when they're used, the types of definitions, and where they're located in a technical document.

How to Use Definitions in Technical Writing

5. How to Use Definitions in Technical Writing

Technical writing often has a number of rather technical terms to go along with it, but that doesn't mean they have to slow down the pace of a document. In this lesson, we look at how to add definitions to technical writing.

Ethical Dilemmas in Technical Writing

6. Ethical Dilemmas in Technical Writing

Technical writers must be aware of ethical dilemmas that could mislead readers. This video addresses how to avoid ethical dilemmas in order to keep you and your company's reputation positive.

Mistakes of Composing Definitions in Technical Writing

7. Mistakes of Composing Definitions in Technical Writing

Writing definitions for technical documents goes beyond just giving the dictionary definition. This video explains common mistakes to avoid when writing definitions for technical documents.

Writing Technical Descriptions

8. Writing Technical Descriptions

Descriptions are valuable for identifying the physical features of a product. This video explains the elements of good descriptions and shows you how to write them.

Writing Technical Specifications

9. Writing Technical Specifications

Businesses must meet specifications during the creation of a product. This video provides the definition of a technical specification and explains how to write a closed specification.

Introductions of Technical Documents

10. Introductions of Technical Documents

Introductions are vital to helping your reader understand the context, purpose and structure of your document. This video explains the purpose and content of introductions in technical writing.

Conclusions of Technical Documents

11. Conclusions of Technical Documents

Technical writing should always end with a conclusion in order to provide readers with a final outcome of the presented data. This video explains why and how to write a conclusion for your technical documents.

Recommendations in Technical Documents

12. Recommendations in Technical Documents

Some technical documents require you to tell the reader what actions to take as a result of the information provided. This video explains how to write a recommendation for technical documents.

Chapter Practice Exam
Test your knowledge of this chapter with a 30 question practice chapter exam.
Not Taken
Practice Final Exam
Test your knowledge of the entire course with a 50 question practice final exam.
Not Taken

Earning College Credit

Did you know… We have over 200 college courses that prepare you to earn credit by exam that is accepted by over 1,500 colleges and universities. You can test out of the first two years of college and save thousands off your degree. Anyone can earn credit-by-exam regardless of age or education level.

To learn more, visit our Earning Credit Page

Transferring credit to the school of your choice

Not sure what college you want to attend yet? Study.com has thousands of articles about every imaginable degree, area of study and career path that can help you find the school that's right for you.

Support