Scott on Writing

Musings on technical writing...

Musings About How Not Write a Technical Book

Jeff Atwood recently published a blog entry titled How Now to Write a Technical Book, in which he compared Charles Petzold's latest book to Adam Nathan's. In short, Charles's book - Applications = Code + Markup - lacks the color, diagrams, screen shots, and structural elements (like bullet points, tables, sidebars, and so forth) that are found throughout Adam's book, Windows Presentation Foundation Unleashed. To highlight the difference in style/layout, Jeff includes screen shots from both books. Charles's text is drab and gray, Adam's is bright and dynamic. The code looks like it does in Visual Studio; the figures, headings, and bullet points help break up the flow of the text.

Jeff's analysis follows:

“Beyond the obvious benefit of full color printing, which adds another dimension to any text, it's not even close. The Nathan book is the clear winner:

  • It's full of diagrams, screenshots, and illustrations showing the meaning of the code.
  • The text is frequently broken up by helpful color-coded sidebars such as "digging deeper", "FAQ", and "warning".
  • The code/markup snippets are smaller and easier to digest; they don't dominate page upon page of the text.
  • Liberal use of bullets, tables, subheadings, and other textual elements provides excellent scannability.
  • The book has a sense of humor without being obnoxious or cloying.
  • Did I mention it's in color?

“The Nathan book is brilliant. It reads like a blog and competes toe-to-toe with anything you'd find on the web. Petzold's book, in contrast, is a greyscale sea of endless text and interminable code. There are so few diagrams in the book that you get a little thrill every time you encounter one. It also artificially segregates code and markup: the first half is all C# code; it's not until the second half that you see any XAML markup whatsoever, even though XAML is one of the most important new features of WPF, and the one developers will be least familiar with.“

Charles has responded to Jeff's comments via a blog entry of his own titled, The Future of Writing?

“I've been mulling over Coding Horror's analysis of two WPF books, not really thrilled about it, of course. The gist of it is that modern programming books should have color, bullet points, boxes, color, snippets, pictures, color, scannability, and color.

“Does that remind you of anything?

“Apparently the battle for the future of written communication is over. Prose is dead. PowerPoint has won.“

I don't know Charles personally, but from his online reaction it sounds like he is taking Jeff's (constructive) criticism a little too personally. And Jeff's comments do remind me of something - web developers (like myself) who develop very functional but very ugly web applications only to have customers and managers and the graphics guys come in and say, 'Holy crap, that's an ugly website, we need to add some icons and background images.' When this happens, there's two ways to response:

  • Take their suggestions/comments/changes as an insult to your web development skills, or
  • Realize that you do some things well (backend web development, data modeling, software architecture, etc.) and there are other things that you are not so hot at and others excel at (layout, design, usability, etc.).

Charles response sounds similar to the discourse you'll hear from a coworker who decides to response to criticism on his website's layout using option #1 above. And just like that coworker, Charles is wrong. Design matters. It doesn't trump functionality, but it does matter as design affects usability, which, for a book, is its readability. As one commenter in Jeff's entry wrote: 'I have both books and Petzold's book actually made me loose interest in WPF. It's just depressing to read that thing.'

Adam Nathan's book is published by Sams Publishing, which doesn't surprise me. I've written all but one of my books with Sams and their editors have always encouraged using different elements to break up the flow of text, be it figures, bullet points, notes, sidebars, warnings, code listings, notable quotes from the book's text, and so on. When submitting chapters for review to my editor at Sams, I found that if I had a page or more of solid text, I'd get a comment suggesting various elements to break up the text. And while my technical books with Sams were all in gray scale, I also wrote a book for Sams for the beginners market titled, Create Your Own Website. This book was in color and on every other page (or so) the margin included a sidebar that had further information or ideas for developing their own website or online tools they could use (such as validators, free images and clipart, free design templates, and so on).

For more on this discussion on this topic, check out the comments in Jeff's blog post. There's also a good entry by Phil Haack: Prose Is Dead. Long Live Prose.

(An aside - Jeff provided his own constructive criticism at my last book's title in his post, Teach Yourself ASP.NET 2.0 in 23 Hours, which highlights the flaws in titling books Learn X in TimeUnit. And while the naming scheme does have its drawbacks, I vehemently disagree with Jeff's final conclusion 'that books with titles like Teach Yourself ASP.NET 2.0 in 24 Hours cheapen our craft.' My response was a long-winded blog entry titled, Can You Learn ASP.NET in 24 Hours?)

posted on Saturday, April 28, 2007 12:08 PM

Feedback

# re: Musings About How Now to Write a Technical Book 4/28/2007 1:34 PM Scott Elkin

Great post Scott. Both Jeff, Phil and now you have hit the nail on the head, and I think ultimately, will change our technical books for the better.

Yes, Charles may be a little miffed now, but give him time and even he will find that his next book has more "design" - even if it is so subtle he doesn't notice.

# re: Musings About How Now to Write a Technical Book 4/29/2007 5:30 PM Scott Mitchell

Charles has posted a more lengthy response to Jeff Atwood on his blog:
http://www.charlespetzold.com/blog/2007/04/290143.html

# re: Musings About How Now to Write a Technical Book 4/30/2007 7:54 AM Long Time Reader, First Time Commenter

The correct title for Atwood's post is 'How Not to Write a Technical Book.'

# re: Musings About How Now to Write a Technical Book 4/30/2007 8:10 AM Scott Mitchell

Hi, LTRFTC. Where did I refer to Jeff's post incorrectly? In the first sentence I say: "Jeff Atwood recently published a blog entry titled How Now to Write a Technical Book."

# re: Musings About How Now to Write a Technical Book 4/30/2007 3:11 PM A different Scott

Scott look closer at your title. Now should be *Not*

# re: Musings About How Not Write a Technical Book 4/30/2007 3:30 PM Scott Mitchell

<slaps_forehead />

Thanks for pointing out the obvious to me! :-)

# re: Musings About How Not Write a Technical Book 2/25/2008 3:35 PM Pete Boeterente

I was searching for more details on how to right an academic technical book. Unfornatunately I only get the book title :)

# re: Musings About How Not Write a Technical Book 5/15/2008 2:10 PM Bob

In the anime, Reiko and Sudou are portrayed as the bad guys and 3 of the guys from the manga club portrays themselves as Kotoko's character handsome and dashuing rescuer. To Kotoko's humilation, in one part, Tennisu no Onna's clothes was destroyed by Sudou's character. Naoki bursts out laughing at this part.
http://pro-samer.info/index.php?id=97
http://kriomotors.info/index.php?id=40
http://pro-samer.info/index.php?id=31
After the anime ends, Kotoko and Naoki meets Papa, Mama, Yuki and Sai. Mama then enters Naoki and Kotoko into one of those quiz. In the quiz, Naoki refuses to answer any of the questions despite knowing the answer. So Kotoko presses the buzzer each time after the question and asks Naoki to answer the questions. In the final question, the oppenent answers wrongly and the question thrown to Naoki's and Kotoko's team. Kotoko gives the correct answer. They win the quiz. The prize is a trip.

# re: Musings About How Not Write a Technical Book 5/15/2008 2:10 PM Frenk

Goog blog
http://triometr.info/index.php?id=161
http://triometr.info/index.php?id=264
http://basker.info/index.php?id=146

Title:  
Name:  
Url:
Protected by Clearscreen.SharpHIPEnter the code you see:
Comments   

Add To Your Reader

My Links

Archives

Post Categories

 

I am a Microsoft MVP for ASP.NET.
I am an ASPInsider.
<May 2008>
SMTWTFS
27282930123
45678910
11121314151617
18192021222324
25262728293031
1234567

Comment Stats

DayTotal% of Total
Sunday 1866.8%
Monday 37913.9%
Tuesday 45316.7%
Wednesday 50418.5%
Thursday 53519.7%
Friday 49418.2%
Saturday 1666.1%
Total 2717100.0%

Hour1Total% of Total
12:00 AM 652.4%
1:00 AM 682.5%
2:00 AM 622.3%
3:00 AM 742.7%
4:00 AM 572.1%
5:00 AM 1033.8%
6:00 AM 1084.0%
7:00 AM 1585.8%
8:00 AM 1716.3%
9:00 AM 1475.4%
10:00 AM 1716.3%
11:00 AM 1816.7%
12:00 PM 1886.9%
1:00 PM 1696.2%
2:00 PM 1605.9%
3:00 PM 1324.9%
4:00 PM 1073.9%
5:00 PM 923.4%
6:00 PM 913.3%
7:00 PM 963.5%
8:00 PM 833.1%
9:00 PM 782.9%
10:00 PM 792.9%
11:00 PM 772.8%
Total 2717100.0%

Comments by Blog Entry Date/Time

Day Entry MadeAvg.Total
Sunday 5.54144
Monday 5.22339
Tuesday 4.28419
Wednesday 7.67637
Thursday 6.90607
Friday 5.48411
Saturday 5.33160
Total 5.842717

Hour1 Entry MadeAvg.Total
12:00 AM 5.0035
1:00 AM 1.002
5:00 AM 0.000
7:00 AM 7.0035
8:00 AM 5.35107
9:00 AM 6.32278
10:00 AM 6.47246
11:00 AM 4.41181
12:00 PM 6.88330
1:00 PM 3.00111
2:00 PM 5.41222
3:00 PM 8.64285
4:00 PM 4.0589
5:00 PM 5.92154
6:00 PM 4.52113
7:00 PM 9.67174
8:00 PM 9.80147
9:00 PM 5.05111
10:00 PM 5.4265
11:00 PM 4.5732
Total 5.842717

Learn More About Comment Stats
1 - All times GMT -8...


Blog Stats

Favorite Web Sites

My Books

My MSDN Articles