Tag: Introduction

Getting the Most from Your Technical Reading Experience

This is an update of a post that originally appeared on July 20, 2011.

There are many ways to work with books. However, in all cases, there is some work involved. No book, no matter how well researched and written, will simply spit out answers without any effort on the reader’s part. It’s true that the author can employ techniques to make the reading experience more pleasurable, productive, or efficient, but in the end, it’s the reader who decides just how much information a book conveys with regard to a specific need.

Of course, the first step is to ensure you get the right book. I’ve already discussed this issue in the Techniques for Choosing a Technical Book post. So, let’s assume that you have possession of a book that’s the best possible match to your needs. It may not be a perfect match, but it offers more than any other book you’ve checked.

Now you have to decide on how to interact with the book. That may seem simple, but many readers fail to discover what they need from a book, even when the book contains the required information in several places. Let’s face it, books are relatively large and it’s easy to lose track of a required bit of information. Without some guideline, the mind wanders and tends not to work very hard.

To obtain the most from a book you need a goal. The goal determines how you approach the book. Someone who is trying to learn a new skill will probably begin at the front of the book and work toward the end. Skipping chapters is akin to skipping classes in college—you can’t expect good results if you don’t obtain all of the information. As a contrast, someone who is trying to fix a specific problem under the watchful eye of a boss, probably doesn’t want to waste any more time than necessary finding the required information. This sort of reader will want to locate the section of the book containing the answer quickly. There are some readers though, who really don’t know what they want to do—they lack a goal and are thwarted when the author can’t guess what the reader wants. So, ask yourself why you’re reading the book and create a goal for that particular session. In some cases, you may very well want to wander through the book randomly looking for something interesting, but few people have the time or need to perform this sort of reading with a technical book.

Depending on your goal, you’ll want to determine where to start. Someone who is learning a skill will start in the Introduction—not in Chapter 1. If you don’t read the Introduction, you’ll discover that your educational experience is going to be less helpful. The Introduction is where the author conveys book goals, knowledge requirements, and required training aids. For example, you might not be able to use the educational version of the product you have to learn a new skill with this particular book—it may be necessary to get the released version of the product instead. Researchers and those who simply need the book for reference would do well to check both the Table of Contents and the Index. A book intended solely for reference may include tables in an appendix that provide additional ways to locate information, so you’ll want to find these tables as well.

You’ve likely heard all of the advice for creating a good study environment before, such as turning off the radio. A good study environment also requires focus on your part and the availability of the required equipment. Simply reading about how to perform a task isn’t nearly as good as actually performing the task. Reinforcing the information by putting it into your own words is helpful as well. Everyone learns differently, so it’s important that you take time to discover how you learn. Whatever it takes for you to create a good study environment, you won’t get much out of a book until you create it.

Everyone seems to be in a hurry today, but being in a hurry won’t help with technical information. Hurrying only creates errors. Take time to actually read and understand the material—read it several times if necessary. Work through the material before you act. Yes, I realize that the boss is ready to pound little knots all over your head, but he’s simply going to have to wait. A good solid answer that produces results often requires a little more time up front to create. The book probably has the information you need, but you have to take time to find it.

One of the most important things to remember is that the author isn’t clairvoyant. You won’t find a precise answer to any given question in any book. It’s possible to find an answer that’s close, but in most cases you’ll have to create a solution based on the information the book provides—quick answers are rare.

I wish it were possible to create some form of instant mental transfer of precise data. Perhaps someday it will become the norm to do so, but I hope I’m not around. Part of the joy of technical reading is obtaining the author’s point of view and then creating your own permutations of that information. Working through problems creatively is a challenge—one that I hope people working in technical areas continue to enjoy. If you have any pointers to getting more from a technical reading experience, let me know at [email protected].

Techniques for Choosing a Technical Book

This is an update of a post that originally appeared on April 13, 2011.

I often get e-mails from potential readers asking whether a book I’ve written is the right choice for them. I try my best to ask about their needs and provide an unbiased answer. It’s in my best interest to provide the best answer I can, rather than make a quick sale and have to deal with a discontented reader later. However, in all honesty, it’s hard for me to be completely unbiased because I know my books better than any other book out there. I’ve spent many hours carefully crafting my books and know them quite well. Even when I read a work written by someone else, which I do regularly, I’m less familiar with it. Still, I do try my best to provide a good answer.

Getting a potential reader to make a good selection is still the best scenario in my mind. A number of readers have asked that I provide them with some specific technique for doing this, but all I can offer is a partial solution. The technical content of a book is only part of the solution for any reader. A reader must also consider the author’s method of presenting material and writing style. The use of teaching aids is also important. You must ask whether you want a book that contains questions or activities at the end of each chapter—many readers learn more by doing, than by reading. Communication, even in books, is a two-way process. The author often communicates ideas in subtle ways that help some readers and offend others. When a reader writes to an author, the author picks up subtle hints on how to improve the next book. It’s an ongoing process.

Everyone begins looking for a book by viewing the cover. Something about the title tells you that this could be a helpful book. The cover design and text tell you something about the book’s content from a marketer’s perspective. If you stop here, however, be prepared for disappointment. I’ve had more than a few covers that just didn’t do justice to the content of my book and a few that ended up misleading some part of the reader population. Believe me when I say that it’s never my goal to mislead anyone—I want my readers fully informed before making the purchase and happy with the book they receive. Covers are incredibly hard to get right because there is so little space on them to convey information that’s truly useful to everyone.

When I select a book, I normally begin by reading the Introduction. This important bit of reading is only seven or eight pages long in most cases, but usually characterizes the author’s attempt to convey everything the book contains as an overview. Reading the Introduction tells you about the author’s writing style and informs you about skills required to use the book successfully. You also discover special equipment and software that you need to use the book. If you find yourself disagreeing with the Introduction, you can be certain that you won’t like the rest of the book either.

Most people purchase their books online today. Gone are the days of browsing for books in bookstores, which is a shame because I found many unexpected treasures that way. I still go to a bookstore when I can, but most of the time I have to make do with a site like Amazon.com. With this in mind, make sure you avail yourself of the Look Inside feature and take the time to read things like the table of contents, introduction, and a writing sample. Some publishers hide the content of their books and don’t provide a Look Inside feature. I generally don’t buy these books because it’s not possible to know what I’ll get.

Next, I look at the Table of Contents to determine whether the topic I need is covered in sufficient detail to warrant a purchase. A book’s title and cover material is often deceiving. The Table of Contents tells me more about the book content from the author’s perspective. I go through the entire Table of Contents just to see what sorts of interesting information the author has decided to include. I may also thumb through the index to determine more about topics covered in the book. It’s important to note that the index is normally created by a professional indexer and not the author, so the index may not tell you everything you need to know, but it’s a great place to see the sorts of topics the author has chosen to discuss.

Finally, I go to the specific chapters that I feel provide the information that I want from the book. (When I can’t see the specific chapter I want online, then I at least try to read through the sample chapters that the publisher does provide.) I’ll eventually read most of the book, but these chapters are my main reason for buying the book today, so that’s where I look. I probably won’t read the entire chapter in the store (or online using Amazon’s Look Inside feature), but I’ll scan it and pay attention to particulars such as the code provided in examples or figures used for explanation. I’ll read segments of the discussion to see how much information the author provides and how the information is conveyed.

I know that many people consider my approach too time consuming. It is a time consuming approach, but I find that I make fewer bad purchases using this technique. I’ve had more than a few people write to me to ask why I didn’t cover a particular topic in my book and I have to wonder why they didn’t realize that the material was missing when they made the purchase. A few readers have literally written that they ran into the store during lunchtime (or checked it out on Amazon), looked at the cover and decided the book must include what they need, put down their hard earned money to buy the book, ran back to work, and only then bothered to look inside. If you truly are pressed for time, please do write before buying one of my books. I’ll provide you with the least biased answer I can. However, the best way to buy a book is to make your own decision using the techniques found in this post. Let me know your ideas about buying books at [email protected].

Facing the Blank Page

Most writers face writer’s block at some point. You have a blank page that’s waiting for you to fill it and you have a vague notion of what you want to say, but the text simply doesn’t come out right. So, you write, and write some more, and write still more, and hours later you still have a blank page. Yes, you’ve written many words during that time—all of them good words—just not the right words.

Every piece of writing I do starts with an outline. Even my articles start with an outline. Creating outlines help you focus your thoughts. More importantly, they help you to see how your thoughts will flow from one idea to the next. Sometimes, if you’re honest with yourself, you’ll discover that you really don’t have anything more than a vague idea that will never become an article, white paper, book, or some other piece of writing. Of course, that’s really the reason for this exercise—to see if you have enough information to even begin writing. If you don’t have enough information, then you need to research your topic more. Research can take all sorts of forms that include everyone from reading other texts on the topic, to doing interviews, to playing. That’s right, even playing is an essential part of the writer’s toolbox, but this is a kind of practical play that has specific goals.

Once you do have an outline and you’re certain that the outline will work, you need to mark it up. My outlines often contain links to resources that I want to emphasize while I write (or at least use as sources of inspiration). A lot of writers take this approach because again, it helps focus your thoughts. However, an outline should also contain other kinds of information. For example, if a particular section is supposed to elicit a particular emotion, then make sure you document it. You should also include information from your proposal (book goals) and your reader profile (who will read a particular section) in the outline. Your marked up outline will help you understand just what it is that you really want to write. In reading your outline, you can start to see holes in the coverage, logic errors, and ideas that simply don’t fit.

Moving your outline entries to the blank page will help you start the writing process. Convert the entries to headings and subheadings. Ensure that the presentation of the headings and subheadings is consistent with the piece as a whole. Unfortunately, you can still end up with writer’s block. Yes, now you have some good words on the page, but no real content. An outline is simply a synopsis of your ideas in a formalized presentation after all.

Write the introduction and the summary to the piece next. The introduction is an advertisement designed to entice the reader into moving forward. However, it also acts as a starting point. The summary doesn’t just summarize the material in the piece—it provides the reader with direction on what to do next. People should view a good summary as a call to action. By creating the introduction and the summary, you create the starting and ending points for your piece—the content starts to become a matter of drawing a line between the two from a writing perspective.

At this point, you have enough material that you could possibly ask for help. Try reading your piece to someone else. Reading material aloud uses a different part of the brain than reading the same material silently. Discussing the material with someone else places a different emphasis on the material. The other party can sometimes provide good suggestions. You may not use the suggestions directly, but listening carefully can often present you with creative ideas that you wouldn’t have considered otherwise.

It’s important not to overwork the piece. Sometimes you need to do something else for a while. Yes, you always want to spend time in research and thinking your piece through, some writing is often done in the subconscious. Fill your head up with as many creative ideas, fascinating thoughts, and facts that you can, and then do something that actually will take your conscious mind off the topic. You might watch a television show or movie, go for a while. have coffee with a friend, take a nap, or do any of a number of other things. The important thing is to forget about the book for a while. Often, you’ll find that the now semi-blank page doesn’t present a problem when you return. Let me hear about your ideas for dealing with the blank page at [email protected].

 

Writing the Introduction and Summary

I read a lot of books in a year. In fact, it’s not unusual for me to read a book or two every month of the year. While it may take three or more months to read something for pleasure, such as a favorite fantasy novel, technical books usually receive my intense interest for less than a month. Once I pick it up, I’ll keep reading until I’ve finished the book. Unlike many readers, I do read technical books end-to-end so that I can pick up new writing techniques, as well as information. When it comes to technical books, I’ve found that there are usually two flaws that make me scratch my head: the introduction and summary.

The introduction is akin to an advertisement or possibly an invitation. You want to provide a reader with a good reason for viewing the material. After all, the reader’s time is precious and there are many authors on the market peddling their wares. An invitation to read a particular chapter is not only necessary, it’s essential if you want the reader to spend time with the book. A good introduction highlights the reasons why the reader should continue and tempts the reader with the fine fare you’ve diligently created. However, introductions should also be short. You have about 30 seconds to convince someone to read a chapter—possibly less in this day of the sound bite. Instead of focusing on the question of what, the author should tell the reader why. It’s important to say why the reader should read the chapter and describe how much the reader stands to gain by doing so.

Summaries are eschewed by most readers for good reason—they’re boring. In many cases, it’s obvious the author didn’t devote much thought to the summary, so it isn’t hard to figure out why the reader doesn’t devote any time to it. Over the years, I’ve stopped calling the end of the chapter a summary because the term has picked up such a terrible meaning. Rather, I use a heading that at least promises to excite the reader a little. My summaries do tend to follow a formula that I modify as needed to satisfy the requirements of the target reader for my book. I write three or four paragraphs that answer these questions:

 

  • What is the most important bit of information the reader can take away from the chapter?
  • Now that the reader has new information, how can the reader apply it in a specific way?
  • How does the next chapter expand on the content of this chapter (or what new topic does it cover)?

In working with the introduction and summary, I’m careful not to develop new information. I simply direct the information I cover in the body of the chapter in a specific way. Yes, the summary does imply new information in the form of a call to action, but the call to action is not the topic I’m discussing, but rather invites to the reader to apply what the chapter has taught in order to make the lessons more permanent.

The content of the introduction and summary does vary by publisher. Specific series have specific requirements and I always do my best to make use of these requirements in a way that helps the reader obtain the most from that particular chapter. In addition, beta readers have often requested that I include some special feature in either the introduction or summary to help make the chapter more useful. I listen to these comments carefully because the beta readers probably know better than I do what will attract another reader’s attention.

Summaries can be especially hard. There are times where I’ll rework a summary several times to get the effect I want. In some cases, my summaries will include questions or other special features because simply telling the reader to go out and use the information learned seems inadequate to address the topic at hand. No matter how you write your introductions and summaries though, you do need to treat them as an important part of the chapter. The first invites the reader into the chapter and the other bids the reader adieu. Both provide the reader with a lasting impression of your skill as an author and both change the way the reader views the content of the rest of the chapter.

What is your reaction to technical book introductions and summaries? Do you often feel as I do, that they are simply bolted on as a means to start and end the chapter, but not much else? What would you like to see in an introduction or summary? Let me know your thoughts on the topic at [email protected].