Copyright

Organization in Technical Documents

An error occurred trying to load this video.

Try refreshing the page, or contact customer support.

Coming up next: Achieving Unity in Technical Writing

You're on a roll. Keep up the good work!

Take Quiz Watch Next Lesson
 Replay
Your next lesson will play in 10 seconds
  • 0:01 Organizational Nightmare
  • 1:54 Headings and Subheadings
  • 4:11 Typographical Cues
  • 6:04 Table of Contents
  • 6:47 List of Figures and Index
  • 7:38 Lesson Summary
Save Save Save

Want to watch this again later?

Log in or sign up to add this lesson to a Custom Course.

Log in or Sign up

Timeline
Autoplay
Autoplay
Speed Speed

Recommended Lessons and Courses for You

Lesson Transcript
Instructor: Suzanne Sweat

Suzanne has taught 12 years in the NC Public School System and three years at Campbell University. She has a master's degree in English Education.

In order for our readers to understand what we are trying to communicate, we must effectively organize our information. This video provides tips on how to organize writing for technical documents.

Organizational Nightmare

During my first year of teaching, any paper I received went into one small, black tray that sat on my desk. The pile grew daily and contained everything including papers I needed to grade, memos from our principal, lesson plan ideas, and worksheets I needed to copy. The organizational system seemed great at first, because if I needed anything, I knew exactly where to find it - sort of.

The problem with my organization became apparent about two weeks into the school year when my tray began to overflow, and it would take me hours to find something I needed. I realized that putting everything into one spot without any directional hint as to where each item was located only led to wasted time and frustration.

Thankfully, a friend of mine rescued me from my organizational nightmare by introducing me to file folders. Soon, I had a filing cabinet full of folders for lesson plans, worksheets, graded papers, and memos. The system made my life so much easier because I could easily see in big, bold letters what I had and where my items were located.

Writing needs the same sort of organizational system as we do. If we simply place everything we want to say in one large paragraph, it becomes difficult for the reader to know where each piece of information is located, and soon the reader experiences information overload. We must organize, or arrange in a clear, ordered manner, our writing so that readers know what information we are providing and can quickly access the information.

To improve organization in technical writing, include the following items as part of your document:

  • Headings and subheadings
  • Typographical cues
  • Table of contents
  • List of figures
  • Index

Headings and Subheadings

A heading is a title that indicates the topic of a section of text. Headings provide readers with a visual cue to an important topic and help break the information in a document into smaller chunks. Styles for headings will vary from having every letter capitalized to being centered on the page, depending on the document. However, all headings and subheadings should be bolder in color and larger in font than the surrounding text.

A heading is not needed for every paragraph. Instead, group similar information in two or three paragraphs together under one heading, and try to limit the number of headings you include to two to three per page. If you need to add in more distinctions, you can include subheadings for paragraphs between headings that provide more specific information about the paragraphs but have a slightly smaller font and boldness than the original heading.

When including headings, make sure that they are written in short, specific phrases that are parallel in structure and are self-explanatory. You should not include articles (such as a, an, or the) or pronouns. Let's examine some good and bad headings:

  • 'This paragraph is about the effects of sunlight on plant growth.'

The problem with this headline is that it's too long. The headline should simply say, 'Effects of Sunlight on Plant Growth.'

  • 'Background on Plants'

Though short, this headline does not provide the specific details a reader needs in order to know what information the paragraph will contain. A better headline would be, 'Life Cycles of Plants.'

  • 'The Food of Plants and How They Process It'

This headline contains an article ('The') and two pronouns ('They' and 'It'), both of which you want to stay away from including as part of a headline. Instead, consider making this headline more concise by writing, 'How Plants Process Food.'

Headlines are an important part of organizing your technical document because they help divide long text into easy-to-understand chunks and they allow the reader to quickly skim the main topics and find information they need. They act as the folders under which you can file information within a document.

Typographical Cues

I teach high school English and, though I hate to admit it, I know that sometimes class can get a little boring. So, when I find my students beginning to nod off, I yell out random words, like 'burp' or 'zombie.' The kids immediately jolt upright and want to know what's going on. The verbal cue is enough to help them refocus on what we are reading, at least for a minute.

Reading a long string of text can be very difficult. Minds start to wander and pretty soon, important information is lost in the document. So sometimes, we need to provide a visual cue to the reader so that they can be jolted out of their brain fog and refocus on the information we are providing. That's what typographical cues do. Typographical cues are textual effects that emphasize a point. Typographical cues can include any of the following:

To unlock this lesson you must be a Study.com Member.
Create your account

Register to view this lesson

Are you a student or a teacher?

Unlock Your Education

See for yourself why 30 million people use Study.com

Become a Study.com member and start learning now.
Become a Member  Back
What teachers are saying about Study.com
Try it risk-free for 30 days

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.

Create an account to start this course today
Try it risk-free for 30 days!
Create an account
Support