How to Write a Hack for O'Reilly

Hacks Series
[Ed note: this was originally posted on the O'Reilly Network on August 30, 2005.]

As lead editor for O’Reilly’s Hacks series, I field proposals for Hacks books on a daily basis. I also usually have several books in various stages of acquisition, writing, or production, all of which of course have authors and (this being Hacks) numerous contributors. Beyond the questions about which topical areas we’re looking to publish on, the questions that come up most often are usually variations on the theme of what makes a hack and how one should be written.

I’ve long wanted to write something for current and prospective authors, contributors, and other O’Reilly editors (to share with their authors) that explains exactly what we mean by “a nonobvious solution to an interesting problem.” But, of course, I haven’t had the time to do so, so I often go through various rounds of trying to explain something that, when it comes right down to it, you really need to just grok. Unfortunately, after a few attempts to put a fine point on the term hack (as used by O’Reilly), I often end up resorting to a description that’s not much better than Justice Stewart’s infamous definition of obscenity: namely, “I know it when I see it.”

Today, I was discussing a new project with Paul Bausch, who has established himself as a model author for the series (including Amazon Hacks, the forthcoming Yahoo! Hacks, an as-yet-unannounced third Hacks title, Flickr Hacks, and Google Hacks, Third Edition), and I learned that he’d quietly drafted his own take on this theme. Paul’s an author who groks the Hacks format with little need for supervision or guidance, so I was particularly interested in his perspective. He didn’t disappoint, so I asked him to share his sage advice with the world. Thankfully, he agreed.

Here’s what he describes as his Hack template:

I view a hack as a project the reader can accomplish. The reader also needs to know why they might want to accomplish the project and have an idea of what the project should look like when they’re finished. Here’s my template:
  1. Why this hack is needed (story, build desire)
  2. Describe the relevant features
  3. Hack prerequisites
  4. Hack code/procedure
  5. Example of the Hack in action
  6. Brief summary (why the reader rocks!)


  7. If possible, Hack alternatives
Whenever possible I use the conventional Hack headings of The Code and Running the Code to separate parts 4 and 5. And the heading Hacking the Hack for part 7.
The rest of his post fleshes out his philosophy and approach in more detail. Though there are certainly things I’d add if given the time, and other views and approaches are certainly welcome (Hacks contains multitudes: it always has room for a variety of perspectives and embraces diversity of opinions and approaches), Paul’s explanation and tips are as great a start as I could have hoped for.


If you’re thinking of writing for the Hacks series, currently writing for us, or just want to get a behind-the-scenes look at how the sausage is made, you’ll definitely not want to miss it.


Recent Entries

Leave a comment


Subscribe to MAKE!Subscribe to MAKE Magazine!

Subscribe today, save 42% and get web access to MAKE free. MAKE Digital Edition is available only to subscribers.

$34.95 / 1 year
(4 Quarterly Issues)

Subscribe now


Void your warranty, violate a user agreement, fry a circuit, blow a fuse, poke an eye out. Make: The risk-takers, the doers, the makers of things... Welcome to Make: Online!


CRAFT Maker Shed Maker Faire MAKE television
Holiday Gift Guides from MAKE
Gifts for Dads
Science and Chemistry
Gifts Under $20
More guides: Santa Claus Machines, Geek Toys for Grown Up Girls & Boys


Check out all of the episodes of Make: television

Alex Rider Dream Gadget Contest
Make: Science Room

Connect with MAKE

Be a MAKE fan on Facebook MAKE on Facebook
Visit our Facebook page and become a fan of MAKE!
MAKE on Twitter MAKE on Twitter
Follow our MAKE tweets!
MAKE Flickr Pool MAKE on Flickr
Join our MAKE Flickr Pool!
    make_tips on Twitter




    Maker SHED

    Advertise here with FM.

    Why advertise on MAKE?
    Read what folks are saying about us!

    Click here to advertise on MAKE!



    Subscribe to MAKE Magazine!

    Make: Online authors!

    Gareth BranwynGareth Branwyn
    Senior Editor


    Phillip TorronePhillip Torrone
    Senior Editor
    | AIM | Twitter


    Becky SternBecky Stern
    Associate Editor
    | AIM | Twitter


    Marc de VinckMarc de Vinck
    Contributing Writer
    | AIM | Twitter


    John ParkJohn Park
    Contributing Writer
    | Twitter


    Sean RaganSean Ragan
    Contributing Writer
    | Twitter


    Matt MetsMatt Mets
    Contributing Writer
    | AIM | Twitter


    Dale DoughertyDale Dougherty
    Editor & Publisher
    | Twitter


    Shawn ConnallyShawn Connally
    Managing Editor
    | Twitter


    Goli MohammadiGoli Mohammadi
    Associate Managing Editor

    Kip KayKip Kay
    Weekend Projects
    | AIM | Twitter


    Collin CunninghamCollin Cunningham
    Contributing Writer
    | AIM | Twitter

    Adam FlahertyAdam Flaherty
    Contributing Writer
    | AIM | Twitter



    More contributors: Mark Frauenfelder (Editor-in-Chief, MAKE magazine), Kipp Bradford (Technical Consultant/Writer), Chris Connors (Education), Diana Eng (Guest Author), Peter Horvath (Intern), Brian Jepson (O'Reilly Media), Robert Bruce Thompson (Science Room)

    Suggest a Site!

    Current Podcast

    itunesdl.gif Weekend Project: Beetlebot Simple robot from your parts bin that avoids obstacles. Thanks go to Jerome Demers for the original article in MAKE, Volume 12. To download the Beetlebot video, click here or subscribe in iTunes. Check out the complete Beetlebot article... More...

    Get the Make: Online sent via email
    Enter your email to receive Make: Online each day:



    MAKE Fascination video series brought to you by Dow

    Make: Education
    MAKE: en EspaƱol MAKE: Japan
    Important please read


    Subscribe to MAKE Magazine!

    Recent Posts from the Craft: Blog