LINQ in Action - LINQ Book & News

My experience writing the LINQ in Action book

As we are about to reach an important step with the LINQ in Action book that will make the first bits public, we start to look back at what we did and how it happened.

Steve, who is working on the book with me, says that writing a book is hard. Roy, who is working on his own book for the same publisher, says that writing a book is like developing software. I agree with both of them!

Let me try to expand on what Steve and Roy wrote and throw in my own experience:

  • As with any other activity you're serious about, including programming, dedicated time and a quiet environment are required.
    You need to get in the flow and preserve the bubble so can actually produce something.
  • Writing is like a full time job.
    As with software, if you are passionate about your work, you are always thinking about what you are writing or going to write, and how to improve it. If you are not a professional writer, you have to share your time with other projects. I'm used to this because I'm always juggling with several projects at the same time, but I guess it can become difficult to handle if your mind is not prepared to this.
  • Defining the table of content (ToC) is the first step. It can take a while, but it's crucial for the rest of the project.
    The ToC should reflect all you want to tell to the reader, and how you want to communicate it. It's all about content, structure, and your book's story. As a writer, the ToC is your roadmap all along the way. A ToC is not perfect on the first shots. For LINQ in Action, we did more than 20 rewrites of the ToC before it reaches its current state. And it can still evolve a bit... We got what we wanted to tell defined pretty quickly, but finding the best way to organize it took some time.
  • To get you started on a chapter, collect all the ideas you want to include in it, and throw them in. Don't worry if it looks like a bunch of wild ideas that don't seem to play well together. As you make progress on a chapter these ideas may fit in the flow. You can always decide as you go if you want to keep a topic, move it to another chapter or throw it away.
  • Writing a book is not a linear task.
    Writing a book, even a technical one, is a creative work. It requires inspiration and this does not come all at once and in a continuous flow. Sometimes you'll be productive, other times you'll feel like you have wasted a lot of time writing just one page. At times, it's important to just let ideas come and what you want to write will end up emerging. Keep pushing to get things done, but allow some time for creativity.
  • A book is not just a collection of chapters put together.
    A chapter is not a standalone piece of work. If it was, you'd be writing articles, not a book. A book's chapters are linked together and build one onto another. When you create the table of content, you define where chapters go because there is a logical order between them. But when actually writing a chapter, you'll find that you should refer the user to some previous chapter and expand an example that was introduced before. You should also let the reader know in advance if you'll get back to a subject later in the book.
  • Not all chapters are the same.
    The kind of work can be very different from one chapter to another. Some chapters are about introducing a topic, some mainly provide code samples, some are more about theory, others are more about best practices, etc. Each chapter is a different story. Of course it's better if your chapters can mix all this together because it's better for digestion :-) Some chapters (most in fact) are very difficult to write because you need to find the right way to explain a specific topic and of course almost no information is available yet about it to help you out.
  • A chapter does not represent a bounded unit of work.
    You can't start one chapter and write it from start to finish. A chapter requires several passes. You write a first draft; you start working on another chapter; your editor reviews your first chapter; you take the edits and comments into account; you resubmit your chapter for review; you get new ideas for your other chapter; you need to update your first chapter because Microsoft finally decided to release a new preview that breaks everything you have written so far; and so on.
  • Refactor, refine, improve, rinse and repeat.
    When you finish (or so you think) your first chapter and you are happy with it, you are eager to send it out for review. You are confident that the content is great, the style better than anything else you have ever written so far, and you get ready to receive positive comments. Maybe someone will find some glitches here or there and suggestions for ways to improve a paragraph or a title, but it should be ok... After all, you spent a month on this chapter! What a disappointment when you have to realize that in fact it's not so great and you have more work to do on it than what you have done so far! A chapter is never finished in one shot, nor in two. A book requires a lot of work, a chapter requires a lot of work, a paragraph, a line, a caption all require work and work and work.
  • Nothing is perfect in this world. Your book won't be either.
    As I wrote, you have to get back to each chapter again and again. But if you are perfectionist or if you listen to all the feedback you can get from all the reviewers, you can quickly feel overwhelmed and get crazy. Everything people will tell you is true and can be used to improve you book in wonderful ways. But this is your book. You write it. Reviewers review and can only make suggestions. You have to make choices, and at some point you have to stop working on a chapter and move on to the next one.
    You need to find the right examples, the best sentence. This is what can make a difference between a good book and a great book, but you can easily become a prisoner of your book. You may want to give as much information as possible, but you have to accept that it's not possible to cover all the details. Throw away some of what you wanted to cover. Keep what's essential and focus on it.
  • Involving friends and other external reviewers in the process is good for your mental health.
    Working on a chapter is a lot of work and can be stressful because there are some deadlines to meet. If you can show to someone what you have so far, even if it's a draft, it can help you actually feel that you do have something done. Feedback helps you make progress in terms of quality of course because your reviewers can tell you what they think of your work, but it also keeps you going on.
  • The reader is king.
    Never forget that you are not writing a book for yourself, but for the reader. Try to think like your reader. What does he know? What does he want to read? Would he be bored by your prose? Have you lost him in your convoluted explanations? Step back a bit and rewrite as if your reader was in front of you and he's reading above your shoulder. Stop once HE/SHE is ok with what you wrote :-)
  • It always takes more time that you expected.
    It's just like with software projects. You think you can finish in time. You tend to ignore the difficulties ahead. Writing a book is hard, but more than that it's very time consuming! Of course it gets harder if you don't have time allocated to this activity. I have the luck to be able to keep time for writing. It's not as rewarding as doing consulting as far as money is concerned, of course. This is something you need to consider seriously if you plan to write a book. All in all it's an interesting challenge, but far too much time consuming.
  • Things are lot harder if you are after a moving target.
    Writing a book is hard and takes time. But if that's not a big enough challenge for you, choose to write about an unreleased product or technology. LINQ is constantly evolving and the shape it will have in the end has started stabilizing only a few weeks ago. We started working on the book several months ago and information was missing on a lot of topics. We had to dig by ourself to understand the technology and investigate to find how things work. I guess that this almost always happens with technological books. Our work as authors is in part to find the information for the readers. It's hard work that adds to the actual writing work.
  • The work varies a lot depending on your publisher.
    Each publisher has it's own processes and quality standards. I don't have experience with other publishers, but I find that Manning is very involved. They don't just take an author or a book and publish it. They guide you and make sure that your book is in good shape. They are also supportive and they are always available if you have questions and need advice. I can see that it's quite different with other publishers, some of which just expect you to deliver on time.
All this ends up a lot longer than I expected, but hopefully it will be useful for someone. It's time for me to get back to the chapter I need to finish...
Feel free to comment I you have a similar or a different experience.
Published Tuesday, March 13, 2007 11:18 PM by Fabrice Marguerie

Comments

 

Speednet said:

Wonderful blog entry.  I have been putting off book-writing for a long time, and will eventually break down and dedicate myself to it.  Your words are very helpful and preparatory.

March 14, 2007 4:47 AM
 

Michael Stephens said:

Mike Stephens, Associate Publisher with Manning here.  I've been working with Fabrice, Steve, and Jim to build Linq in Action.  If you're interested, you should check out the book's page at

http://www.manning.com/marguerie

The book is available now in Early Access form, which means you can order the book and start reading now. There are several chapters available at present and more will be added soon.

As well, there's a forum set up on the book page where you can comment on the book and exchange ideas with other readers.

Enjoy!

Mike

March 21, 2007 9:57 AM
 

Linq in Action News said:

How much do you know about LINQ? With Visual Studio "Orcas" 2008 and .NET 3.5 Beta 1 ready, and Beta

June 19, 2007 7:32 AM
 

Fabrice's weblog said:

How much do you know about LINQ? With Visual Studio "Orcas" 2008 and .NET 3.5 Beta 1 ready, and Beta

June 19, 2007 7:44 AM
New Comments to this post are disabled