Tag: Writing

E-book Integration in Schools

I use every opportunity I can to track the change in how people read information. Some of this material is in articles, some comes from readers and friends, and some comes from just observing. For example, at one time people would grab a magazine from the rack at our doctor’s office. Now it’s quite likely that they’ll take out a Kindle or other reading device to view their favorite novel. Even at our library, I see people sitting in front of computers reading, rather than holding a book. Increasingly, I get questions from readers who use the e-book version of my books, instead of paper copies. Let’s just say that in the year and two months since I wrote The e-Book in Your Future, things have changed considerably. E-books are reducing the cost of reading material of every sort, especially technical books.

That’s the reason I’m a bit concerned about some of the things I read about our school system, especially when conversations with students tend to bear out the information I read. One ComputerWorld article in particular, “The e-book revolution is bypassing U.S. elementary schools” really grabbed my attention. The author, Joe Mohen, makes some astute comments about the benefits of using e-books in schools. As an author, I see significant benefits in using e-books, such as the ability to update the information as needed. Schools often struggle with outdated texts now due to a lack of funds, using e-books greatly reduces the cost of updates making it possible for schools to keep their texts updated.

More worrisome is the fact that most of our colleges still use paper texts. In talking with any number of students, I have yet to find any of them using more than one or two e-books for their classes. Given the high cost of education, it makes sense to reduce costs by providing students with materials in electronic format. A recent Forbes article, “Should College Students Be Forced To Buy E-Books?” makes a strong case for using e-books in colleges. The same article points out that only three percent of students currently use e-books for their education.

My interest in e-book technology isn’t just a passing fancy. Part of the reason I spend so much time delving into this issue is to discover how to serve you best. A large percentage of my readers are college students. What if my books were offered only in e-book format? Would you still buy them? For now, my books will continue to appear in both print and e-book format for the most part, but the time could come when I’m asked about how my readers would be affected if the publisher produced only e-books. To answer that question, I need your input. Let me know your thoughts about e-books, especially in the school environment, at [email protected].

 

Sending Comments and Asking Questions

Anyone who reads my blog for very long understands that supporting my books is a big deal for me. I actively work with my readers because I realize that you have the choice of using books written by other authors. Let’s just say that my support system is one of the reasons you really do want to buy my books. My blog not only answers common questions you have, but also adds examples and other information to the information you already receive through my books, so make sure you keep you eyes peeled for additional information here as well.

The last time I discussed this topic was in 2011 in my Contact Me, Please! post. The same things apply now as they did then. I’ll answer your book-specific questions as soon as I possibly can and in as much detail as I can. However, I won’t write your school term paper for you, accept a marriage proposal, or provide free consulting (amongst other things readers have asked me to do in the past). If you’re having problems with an example or can’t find the book’s source code, please be sure to ask because I want your experience with my books to be nothing less than phenomenal.

I also encourage you to be a beta reader. You can see the posts I’ve made for several recent books. The biggest reason for me to ask readers to participate in the book building process is to ensure you get the book you want. I also want to avoid Errors in Writing. As far as I know, I’m the only technical author on the planet that invites reader comment during the writing process, but I truly feel your input is essential, so I request it in every way I can. As I get new book contracts, you’ll continue to see requests for beta readers posted on my blog.

You can always contact me at [email protected] with any comments and questions you have. This includes both books and blog posts. Let me know about any concerns you might have and I’ll do my best to solve them. In the meantime, happy reading !

 

Too Much Detail

A trend has started in publishing of all sorts and it affects technical writing most of all. A friend of mine recently wrote a piece entitled, “A Multimedia Avalanche.” The post spoke to me on many different levels. As an author, it spoke to me of the need to keep my pieces short and to the point. No one wants to read every detail about every event that has ever happened—it simply isn’t possible to absorb more than the “Reader’s Digest” version of many of the events that take place in our lives. It makes me think of the supposed Sergeant Friday (Dragnet) quote, “Just the facts, ma’am.” The problem with using a medium such as the Internet is that people tend to think in terms of unlimited space, rather than limited reader attention. As an author, it’s important to write concisely, yet clearly.

As a reader, it spoke to my desire to throttle some authors to within an inch of their lives. After wasting my time, they never do seem to get to the point. An editor of mine is famous for pointing to the need to state the purpose of an article within the first paragraph and then to keep the article focused on that purpose. It’s good writing practice to write the beginning and ending of the article first, and then write the material needed to fill in the details. It’s a simple trick to keep the article short and focused.

As a citizen, the article spoke to the need to keep the media in check. No, the government shouldn’t perform this task; the reader should. When the media hypes a story all out of proportion, it brings out the mob mentality of some people. Suddenly, the government finds itself swamped with calls for needless changes for a non-event that was sensationalized by someone who wasn’t thinking. These sorts of issues tend to waste considerable funds that could be better used for other purposes (such as saving the taxpayer from an increase in taxes).

Information overload, wasted money, wasted time, and other such problems will only increase as citizen journalists and others with way too much time on their hands contribute toward an increasing array of articles that bury the reader in detail. To quote my friend’s article, “just because you can do something doesn’t always mean you should.” It’s good advice.

What is your take on too much detail, especially as it relates to technical writing? Let me know your thoughts 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].

 

Information Overload – The Conclusions

I’ve been
discussing the issue of potential information overload with my blog entries for the past several weeks now (see Information Overload) and it’s time to come to some conclusions. Several of you wrote in to tell me that you’d actually like me to write more. As nice as that would be, my current schedule won’t allow for it. In order to provide you with a high quality of writing, I need to focus my attention on a few good posts, rather that a flood of mediocre ones.

I received a total of 117 e-mails. Three of those e-mails wanted me to publish posts six days a week. Because that wasn’t one of the options, I chose not to chart them as part of the output you see here.

BlogFrequency

Strictly speaking, most of the blog readers would prefer that I publish posts four day a week. As you can see though, the numbers are pretty close. What I’ve decided to do is publish four posts a week from this point on, unless I happen to have an excessively easy week (when I’ll publish five) or an excessively hard week (when I’ll publish three). I’m hoping that the new schedule will meet with everyone’s approval.

As far as content is concerned, I only receive a few messages that talked about it at all. Most people seem quite happy with the content that you see on the blog now. There are some people who like the technical articles best and others who like the self-sufficiency articles best, but even amongst those who expressed a preference, they usually added that they liked at least some of the posts in the other category. For the moment, I’ll continue to post the mix of articles that I do now. Of course, I’m always happy to hear from you about blog issues. Feel free to contact me at [email protected] if you have any questions or concerns about the blog at all.

 

Why Did You Choose that Word?

Readers sometimes question my word choice in a book, which makes me think about how I’d reword the text to make it more understandable. There is a perception that one word will work just as well as another in writing, but that’s not the case. A smart author knows that word choice is incredibly important.  In fact, choosing the right word is something that an author spends a considerable amount of time doing and the reason I encourage authors to build their word power by subscribing to sites such as Word of the Day and A.Word.A.Day. So, just why is word choice so important?

 

  • Each word has a subtle difference of meaning so that equivalent words in a thesaurus aren’t precisely the same.
  • Words with similar meanings have different connotations—or secondary meanings assigned by society to the word.
  • A word carries with it an emotional meaning. Even when words mean about the same thing, the emotions evoked by the words will differ.
  • Some words will appeal more to the reader that others will. No matter how precisely a word fits, it doesn’t matter if the reader has no idea of what you’re trying to say.


There are a number of other reasons that word choice is important, depending on what you intend to write. For example, the number of syllables and the sound of the word are important to poets. Technical writers will often choose a word because it’s the jargon used by the community as a whole. However, the reasons listed here apply to everyone. Believe it or not, even technical writers need to elicit an emotional response or suffer the dubious honor of putting a maximum number of readers to sleep.

Long before a reader ever asks me why I chose a particular word, the editors ask the same question. It’s a good question. Sometimes I use a word because it feels familiar and looks right in a particular location—neither reason is a good one for choosing a word. If I can’t answer the question, then another word might be a better choice. Obtaining the required result from the text means choosing words that fit the situation and the reader’s needs.

There are situations where a number of words will fulfill the need. In this case, the author is free to choose the word that sounds best. This is a situation where the author’s voice comes through to the reader. The reader begins to relate to the author at a personal level through the word choices the author makes. In many situations, word choice reflects regional biases, so the word that feels comfortable also reflects the author’s environment.

Editors can help authors get out of ruts by suggesting alternative words. For example, an author may use the same word so often that it begins to lose its special meaning and choosing one of the useful alternatives will actually result in more varied and interesting material for the reader. Unfortunately, what the editor and the author feel is a great word choice may end up confusing the reader and that’s when I often get e-mail from you.

The next time you’re tasked with writing something, consider why you choose the words that you do. Think about the needs of the reader and what you’re trying to accomplish with the text you’re writing. Let me know your thoughts about word choice at [email protected].

 

A Reminder About Information Overload

Last week I wrote a post entitled, Information Overload. It really is important to me to find ways to serve your needs. If you’ve already responded to that post, please accept my thanks. I’ll be posting the results next week Wednesday. If you haven’t responded, you still have another week to respond to the post by writing a comment or sending an e-mail to [email protected].

Make sure you also tell me about posts that you particularly like or dislike. While it isn’t possible for me to tailor my posts to meet the needs of any specific person, I do try to meet the needs of the majority. Of course, I’m always open to your ideas and suggestions as well. My goal is to provide you with the best content that I can !

 

Information Overload

I’m always looking for ways to serve your needs better. Of course, that means reviewing the statistics for this blog so I know what you find most useful, reflecting on your comments both in the blog and in e-mail, and looking at the latest trends in content presentation. This third possible source of useful information has made me wonder whether I’m not overloading you with information. Check out the post entitled, “Why I Will Be Posting Less” to see for yourself. Information overload is indeed a problem in our society and I would want to be the last one to add to anyone’s burden, especially after writing posts such as Learning to Unplug.

Of course, every blog is different, as are the people who read it. I’m taking a page from Mr. Hyatt’s blog and considering what you need from me in the way of usable information. What I’d like you to do is tell me how often you’d like me to post new additions to this blog:

 

  • Two times a week
  • Three times a week
  • Four times a week
  • Five times a week


You can tell me as a comment to this post or through e-mail at [email protected]. It’s important to me to provide you with enough information, but not to overwhelm you. Of course, if I end up posting less often, I’ll cover some topics a little less often too.

From what I’ve been able to garner from the statistics that the blog software automatically maintains for me, you really do like the eclectic mix of topics on this blog, so I’ll continue in that vein and using about the same percentages of posts as I do now. However, I’d like to hear about any topics you particularly like or dislike. Be sure to e-mail me about your concerns. It’s important to me to serve your needs the best way I can.

I’ll gather statistics for a couple of weeks from you (reminding you at times about this post), and then provide an update here on what I’ve learned. These sorts of discoveries are always interesting and often produce unexpected results. I’m sure you’ll want to know what I discover just as much as I want to learn your thoughts and opinions about this blog. In the meantime, happy reading!

 

How the Internet Affects the Information You Receive

For many years now (centuries, in fact) professional authors, editors, and production staff have worked hard to provide you, the reader, with high-quality material. It isn’t always error free (see Errors in Writing), but these paid professionals do their best to assure the material you get is of the best possible quality. The Internet has changed all that. Today, anyone can write anything and publish it online. Search engines ensure that people can find the information, and you now have the option of reading information that has never been verified, edited, or checked in any way for accuracy or fitness of purpose. We have traded quality for quantity.

I’ve realized that there was a problem for a long time now. Sales of articles, white papers, books, and other forms of writing have declined for all authors for quite some time because people feel they shouldn’t have to pay for something they can obtain free. It’s true, a bargain is always appealing no matter what that bargain might be. However, there is a hidden price for this free material and I’m also pleased to find that some media sources are trying to open a forum for discussing the costs of free writing. The latest article I’ve read on the topic, “Today’s Internet: All the fake news that’s fit to publish,” discusses the topic in clear terms. I strongly encourage everyone to read it because the article does accurately describe the cost to you, as a reader, of the free information available online.

Before the e-mails start popping up in my inbox, yes, I do have a vested interest in convincing you that buying a book is superior to obtaining the information online. After all, I’ve written 90 books to date and I’m currently engaged in writing book 91. It would be remiss of me not to mention that your purchase does help me pay my mortgage and electrical bill. However, my goal in writing this piece is not to line my pockets—I’m truly interested in helping you obtain the best information possible because you need good information to make good decisions. In fact, look at my past blog posts and you’ll find that the quality of your reading experience has always been my prime consideration. I write books because I enjoy writing and knowing that my writing helps people. There are other ways I could earn a living (such as consulting) that would put far more money in my pocket than writing does.

There is always going to be a certain amount of angst over buying something that you can possibly get free. People often make house and auto repairs themselves or ask Jane down the street to do it for them to avoid paying a professional to perform the task. Likewise, you have the option of using the free online sources of information to avoid paying professional authors to obtain, verify, and write that information for you. The quality of the material you receive will generally reflect the source that you obtain it from. Of course, there are people who do write quality material online and provide it to you free (in many cases, through the support of a vendor or organization). The point is that you need to find an information source you can trust in order to use that information to make decisions or learn new skills.

One additional benefit of relying on a professional author that you don’t obtain with an Internet source is support. Most professional authors will post addenda, answer questions, and provide value-added materials, much as I do in this blog, as part of publisher-supported sites, and through e-mail. When working with an Internet author, questions are often ignored and remain unanswered years after they’re asked. The price you pay for a book or other professionally written material includes support that you probably won’t get from other sources. As with anything in life, you must consider the tradeoffs of the decisions you make.

How do you feel about the quality of information you receive from the Internet? Do you see any benefit at all from buying books written by a professional? As I seek better ways to serve your needs, the answers to these questions are becoming increasingly important to me. Let me know your thoughts on the topic at [email protected].

 

Dealing with System Differences in Books

It’s unlikely that there are two computer systems on the planet that are precisely the same. Even if the two systems have precisely the same hardware and software, and the administrator configuring the systems uses an image file so that every setting is in precisely the same place, the two systems will have differences. It could be something as simple as the memory delay for one system is just a tad different than the other system. In fact, timing issues cause programmers more headaches than you might think. Environmental factors also play a role in how two systems work. The temperature in one room might be higher than another—affecting the way the systems work. Everything else considered, the users interacting with the systems will be different. The user is part of the system, after all. Therefore, no matter how hard you try to create two systems that are precisely the same, you’ll fail because there are simply too many variables to consider. These differences, no matter how small and subtle, affect how I write my books. The procedures I write for my books must work well for a wide variety of systems, including the users who are using the book to learn how to perform a task.

Let me state up front that there is always a possibility that a procedure you find in one of my books may not work on your particular system, no matter how much time and effort I put into creating the best procedure possible. I apologize in advance for any errors on my part that hinder your learning. It’s never my goal to make things difficult for anyone—quite the contrary, I take great pleasure in making your life easier. One of the reasons I created my beta reader program is to reduce errors in my books. Another reason is to reduce the chance that you’ll encounter problems with procedures in my books due to system differences. More beta readers mean more test systems and a lower probability that some oddity will get past everyone and make it into my books.

However, the fact remains that no amount of effort on my part will ever produce a procedure that always works on absolutely every system on the planet because each system is unique. I can’t possibly test the procedure on absolutely every system out there—much as hardware vendors can’t foresee potential conflicts or software vendors can’t predict a particular system combination that will cause an application to fail. In fact, given the limited resources at my disposal, it’s quite possible that you’ll encounter a problem with a procedure. When this happens, I invite you to contact me at [email protected]. We’ll work together on a solution to the problem you’re experiencing with the procedure. When a problem is severe enough, I’ll post an update for that book on my blog so that everyone can benefit. After all, the purpose of my books is to help you learn how to do something interesting with your computer system.

There are a few things you can do to reduce the potential for problems with the procedures in my books. The following list contains the difficulties that I encounter most often and solving these issues often helps my readers get back on track with the book.

  • Use the software and hardware that the book is designed to work with. Older or newer versions of software and hardware often work differently and cause the procedure to fail.
  • Read the steps carefully and verify that your display looks similar to the one in the book. Differences between my system and your system will sometimes mean that your screen will look a little different from mine, but the screens should at least look similar.
  • Make sure you have the knowledge required to use the book. I’ve been trying to become more careful in stating the knowledge a reader needs as part of the book’s introduction. If you don’t have this knowledge, you’ll find that you have a hard time learning the material.
  • Check your system for failures. In some cases, a reader’s system isn’t working right in the first place and the failure of the procedure merely mirrors this fact.


I always want to hear from my readers. Your e-mails to me brighten my day because I know someone is using the material I’ve worked so hard to create. I’m quite serious when I say, “Contact Me, Please!” Please do make sure to follow the guidelines in my Sending Comments on My Books post when sending me e-mail so that I have the information needed to help you as quickly as possible.